Metadata

Retrieve all metadata associated with the user's account

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

Authorization

ApiIdentitySessionIdentity

Response

200500

Successfully retrieved all metadata

Body

application/json

id*string

root_cid*string

metadata_cid*string

data_size*number (int64)

state*MetadataState (enum)

activeinactivedeleted

created_at*number (int64)

updated_at*number (int64)

snapshot_idnullable string

Request

JavaScriptCurlPython

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

Response

200500

[
  {
    "id": "text",
    "root_cid": "text",
    "metadata_cid": "text",
    "data_size": 0,
    "state": "active",
    "created_at": 0,
    "updated_at": 0,
    "snapshot_id": "text"
  }
]

Push new metadata to a bucket

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

Authorization

ApiIdentity

Body

multipart/form-data

request-data*string (binary)

JSON payload that precedes the metadata CAR file upload

car-upload*string (binary)

The CAR file containing the metadata to be uploaded

Response

200400401409413500

Metadata pushed and processed successfully

Body

application/json

id*string

state*MetadataState (enum)

activeinactivedeleted

storage_host*string

storage_authorizationstring

Request

JavaScriptCurlPython

const response = await fetch('https://beta.data.banyan.computer/api/v1/buckets/metadata', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({
      "request-data": "binary",
      "car-upload": "binary"
    }),
});
const data = await response.json();

Response

200400401409413500

{
  "id": "text",
  "state": "active",
  "storage_host": "text",
  "storage_authorization": "text"
}

Retrieve a single metadata entry by its ID

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

Authorization

ApiIdentity

Path parameters

metadata_id*string

The ID of the metadata to retrieve

Response

200404500

Successfully retrieved the metadata entry

Body

application/json

id*string

root_cid*string

metadata_cid*string

data_size*number (int64)

state*MetadataState (enum)

activeinactivedeleted

created_at*number (int64)

updated_at*number (int64)

snapshot_idnullable string

Request

JavaScriptCurlPython

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

Response

200404500

{
  "id": "text",
  "root_cid": "text",
  "metadata_cid": "text",
  "data_size": 0,
  "state": "active",
  "created_at": 0,
  "updated_at": 0,
  "snapshot_id": "text"
}

Delete a metadata entry by its ID

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

Authorization

ApiIdentity

Path parameters

metadata_id*string

The ID of the metadata to delete

Response

204404500

Successfully deleted the metadata entry

Request

JavaScriptCurlPython

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

Response

404500

{
  "msg": "text"
}