Keys

PreviousSnapshot NextSnapshots

Was this helpful?

Get all keys for a specific bucket

get

/buckets/{bucket_id}/keys

Authorizations

Path parameters

bucket_idstringrequired

The ID of the bucket to get keys for

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://beta.data.banyan.computer/api/v1/buckets/{bucket_id}/keys' \
  --header 'Authorization: Bearer JWT'

200

500

[
  {
    "id": "text",
    "bucket_id": "text",
    "approved": true,
    "pem": "text",
    "fingerprint": "text"
  }
]

List of bucket keys retrieved successfully

Create a new key for a specific bucket

post

/buckets/{bucket_id}/keys

Authorizations

Path parameters

bucket_idstringrequired

The ID of the bucket to create a key for

Body

pemstring · pemrequired

The PEM encoded public key for the device

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://beta.data.banyan.computer/api/v1/buckets/{bucket_id}/keys' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "pem": "text"
  }'

200

400

404

500

{
  "id": "text",
  "bucket_id": "text",
  "approved": true,
  "pem": "text",
  "fingerprint": "text"
}

Bucket key created successfully

Get a single key for a specific bucket

get

/buckets/{bucket_id}/keys/{bucket_key_id}

Authorizations

Path parameters

bucket_idstringrequired

The ID of the bucket the key belongs to

bucket_key_idstringrequired

The ID of the key to retrieve

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://beta.data.banyan.computer/api/v1/buckets/{bucket_id}/keys/{bucket_key_id}' \
  --header 'Authorization: Bearer JWT'

200

404

500

{
  "id": "text",
  "bucket_id": "text",
  "approved": true,
  "pem": "text",
  "fingerprint": "text"
}

Bucket key retrieved successfully

Delete a key for a specific bucket

delete

/buckets/{bucket_id}/keys/{bucket_key_id}

Authorizations

Path parameters

bucket_idstringrequired

The ID of the bucket the key belongs to

bucket_key_idstringrequired

The ID of the key to delete

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://beta.data.banyan.computer/api/v1/buckets/{bucket_id}/keys/{bucket_key_id}' \
  --header 'Authorization: Bearer JWT'

204

404

500

No body

Bucket key deleted successfully