Buckets

Get all buckets for the user

GEThttps://beta.data.banyan.computer/api/v1/buckets

Authorization

ApiIdentitySessionIdentity

Response

200500

List of all buckets for the user

Body

application/json

id*string

owner_id*string

name*string

type*enum

BucketType

storage_class*enum

StorageClass

updated_atstring (date-time)

Request

JavaScriptCurlPython

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

Response

200500

[
  {
    "id": "text",
    "owner_id": "text",
    "name": "text",
    "type": "BucketType",
    "storage_class": "StorageClass",
    "updated_at": "2024-11-21T06:21:26.823Z"
  }
]

Create a new bucket

POSThttps://beta.data.banyan.computer/api/v1/buckets

Authorization

ApiIdentity

Body

application/json

name*string

type*BucketType (enum)

The type of the bucket

backupinteractive

storage_class*StorageClass (enum)

The storage class of the bucket

hotwarmcold

initial_bucket_key_pem*string (pem)

Response

201400401500

Bucket created successfully

Body

application/json

idstring

namestring

typeBucketType (enum)

The type of the bucket

backupinteractive

storage_classStorageClass (enum)

The storage class of the bucket

hotwarmcold

initial_bucket_keyApiBucketKeyResponse (object)

Request

JavaScriptCurlPython

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

Response

201400401500

{
  "id": "text",
  "name": "text",
  "type": "backup",
  "storage_class": "hot",
  "initial_bucket_key": {
    "id": "text",
    "approved": false,
    "fingerprint": "text"
  }
}

Get a single bucket by ID

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

Authorization

ApiIdentity

Path parameters

bucket_id*string

The unique identifier for the bucket

Response

200404500

Bucket retrieved successfully

Body

application/json

id*string

owner_id*string

name*string

type*enum

BucketType

storage_class*enum

StorageClass

updated_atstring (date-time)

Request

JavaScriptCurlPython

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

Response

200404500

{
  "id": "text",
  "owner_id": "text",
  "name": "text",
  "type": "BucketType",
  "storage_class": "StorageClass",
  "updated_at": "2024-11-21T06:21:26.823Z"
}

Update a single bucket by ID

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

Authorization

ApiIdentity

Path parameters

bucket_id*string

The unique identifier for the bucket to be updated

Body

application/json

namenullable string

replicasnullable integer (int64)

Response

204400404500

Bucket updated successfully

Request

JavaScriptCurlPython

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

Delete a single bucket by ID

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

Authorization

ApiIdentity

Path parameters

bucket_id*string

The unique identifier for the bucket to be deleted

Response

204404500

Bucket deleted successfully

Request

JavaScriptCurlPython

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

Response

404500

{
  "msg": "text"
}