Keys

Get all keys for a specific bucket

GEThttps://beta.data.banyan.computer/api/v1/buckets/{bucket_id}/keys

Authorization

ApiIdentity

Path parameters

bucket_id*string

The ID of the bucket to get keys for

Response

200500

List of bucket keys retrieved successfully

Body

application/json

id*string

bucket_id*string

approved*boolean

pem*string (pem)

fingerprint*string

Request

JavaScriptCurlPython

const response = await fetch('https://beta.data.banyan.computer/api/v1/buckets/{bucket_id}/keys', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200500

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

Create a new key for a specific bucket

POSThttps://beta.data.banyan.computer/api/v1/buckets/{bucket_id}/keys

Authorization

ApiIdentity

Path parameters

bucket_id*string

The ID of the bucket to create a key for

Body

application/json

pem*string (pem)

The PEM encoded public key for the device

Response

200400404500

Bucket key created successfully

Body

application/json

id*string

bucket_id*string

approved*boolean

pem*string (pem)

fingerprint*string

Request

JavaScriptCurlPython

const response = await fetch('https://beta.data.banyan.computer/api/v1/buckets/{bucket_id}/keys', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "pem": "text"
    }),
});
const data = await response.json();

Response

200400404500

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

Get a single key for a specific bucket

GEThttps://beta.data.banyan.computer/api/v1/buckets/{bucket_id}/keys/{bucket_key_id}

Authorization

ApiIdentity

Path parameters

bucket_id*string

The ID of the bucket the key belongs to

bucket_key_id*string

The ID of the key to retrieve

Response

200404500

Bucket key retrieved successfully

Body

application/json

id*string

bucket_id*string

approved*boolean

pem*string (pem)

fingerprint*string

Request

JavaScriptCurlPython

const response = await fetch('https://beta.data.banyan.computer/api/v1/buckets/{bucket_id}/keys/{bucket_key_id}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200404500

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

Delete a key for a specific bucket

DELETEhttps://beta.data.banyan.computer/api/v1/buckets/{bucket_id}/keys/{bucket_key_id}

Authorization

ApiIdentity

Path parameters

bucket_id*string

The ID of the bucket the key belongs to

bucket_key_id*string

The ID of the key to delete

Response

204404500

Bucket key deleted successfully

Request

JavaScriptCurlPython

const response = await fetch('https://beta.data.banyan.computer/api/v1/buckets/{bucket_id}/keys/{bucket_key_id}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

404500

{
  "msg": "text"
}