Clatter Labs
Console

Code Buckets

List backups

View as Markdown

The backups of a bucket.

GETapi.codebuckets.clatterlabs.xyz/v1/buckets/{bucket_id}/backupsbuckets:read

Returns the bucket's backups, newest first, and how many your plan includes.

Authorizations

Authorizationstringrequired

Your API key as a bearer token: Bearer clsk_.... Create keys in the Console with the Code Buckets permissions you need.

X-Clatter-Accountstringrequired

The Account ID that owns the key, like CL-7K2M9QXA. Find it in Console › Settings. A missing value answers 401 missing_account_id; someone else's answers 401 account_mismatch.

Path parameters

bucket_idstringrequired

The bucket id (cbk_…).

Response

200 · application/json

objectstring

list.

dataBackup[]

Backups.

planobject

{ backups_used, backups_included } across your account (backups_included is null when unlimited).

Errors

StatusCodeWhen
401invalid_api_key / missing_account_id / account_mismatchThe key or Account ID is wrong.
402quota_exceededThis month's free tokens are used up.
403insufficient_scopeThe key lacks the permission.
404not_foundNo bucket with that id on your account.
curl "https://api.codebuckets.clatterlabs.xyz/v1/buckets/BUCKET_ID/backups" \
  -H "Authorization: Bearer $CLATTER_API_KEY" \
  -H "X-Clatter-Account: $CLATTER_ACCOUNT_ID"
import os
import requests

headers = {
    "Authorization": f"Bearer {os.environ['CLATTER_API_KEY']}",
    "X-Clatter-Account": os.environ["CLATTER_ACCOUNT_ID"],
}

r = requests.get("https://api.codebuckets.clatterlabs.xyz/v1/buckets/BUCKET_ID/backups", headers=headers)
print(r.json())
const headers = {
  Authorization: `Bearer ${process.env.CLATTER_API_KEY}`,
  "X-Clatter-Account": process.env.CLATTER_ACCOUNT_ID,
};

const res = await fetch("https://api.codebuckets.clatterlabs.xyz/v1/buckets/BUCKET_ID/backups", {
  method: "GET",
  headers,
});
console.log(await res.json());
{
  "object": "list",
  "data": [
    {
      "object": "backup",
      "id": "cbb_h3g7f1d9s5a2q8w4e6r0",
      "bucket_id": "cbk_q7c1r9t2y6u0i3o8p5a4",
      "project_id": "cbp_4k9x2m7q1n8v3c6z0b5w",
      "name": "Before checkout rewrite",
      "code_ref": "9b1f0c5e2a7d43e8b6c1f0a9d2e5b7c4a1f3e8d0",
      "objects": 2,
      "files": 1284,
      "bytes": 131204115,
      "created_at": "2026-10-28T14:05:11.482Z"
    }
  ],
  "has_more": false,
  "plan": {
    "backups_used": 1,
    "backups_included": 1
  }
}