Snapshot

Create a snapshot for the metadata by its ID

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

Authorization

ApiIdentity

Path parameters

metadata_id*string

The ID of the metadata to snapshot

Response

200404500

Successfully created a snapshot of the 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/{metadata_id}/snapshot', {
    method: 'POST',
    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"
}