BucktDocs

List buckets

GET/v1/bucketsbuckets:readSDK: buckets.list

Returns a cursor-paginated list of buckets in the calling organization. API keys scoped to specific buckets only see those buckets.

Query parameters

NameTypeDefaultDescription
cursorstring—Pagination cursor returned in `meta.nextCursor` from a previous request. Omit to start from the first page.
limitnumber20Page size. Range 1–100.
status"pending" | "provisioning" | "active" | "failed" | "deleting"—Filter buckets by their current provisioning status.

Example request

import { Buckt } from "@buckt/sdk";

const client = new Buckt({ apiKey: process.env.BUCKT_API_KEY });

const { data, meta } = await client.buckets.list({
  status: "active",
  limit: 50,
});

Responses

{
  "data": [
    {
      "object": "bucket",
      "id": "bkt_01H8XYZABCDEFGHJKMNPQRSTVW",
      "name": "Marketing assets",
      "customDomain": "files.example.com",
      "region": "us-east-1",
      "status": "active",
      "cachePreset": "standard",
      "cacheControlOverride": null,
      "corsOrigins": [],
      "lifecycleTtlDays": null,
      "maxFileSizeBytes": null,
      "allowedMimeTypes": null,
      "optimizationMode": "none",
      "domainConnectProvider": null,
      "awsAccountId": null,
      "isImported": false,
      "isManagedDomain": false,
      "managedSettings": {},
      "storageUsedBytes": 89421,
      "bandwidthUsedBytes": 1245312,
      "dnsRecords": null,
      "createdAt": "2026-04-20T10:00:00Z",
      "updatedAt": "2026-04-21T14:30:00Z"
    },
    {
      "object": "bucket",
      "id": "bkt_01J9PENDINGGGGGGGGGGGGGGGG",
      "name": "User uploads",
      "customDomain": "uploads.buckt.app",
      "region": "eu-west-1",
      "status": "active",
      "cachePreset": "no-cache",
      "cacheControlOverride": null,
      "corsOrigins": ["https://app.example.com"],
      "lifecycleTtlDays": 30,
      "maxFileSizeBytes": 10485760,
      "allowedMimeTypes": ["image/*", "application/pdf"],
      "optimizationMode": "balanced",
      "domainConnectProvider": null,
      "awsAccountId": null,
      "isImported": false,
      "isManagedDomain": false,
      "managedSettings": {},
      "storageUsedBytes": 0,
      "bandwidthUsedBytes": 0,
      "dnsRecords": null,
      "createdAt": "2026-04-22T08:15:00Z",
      "updatedAt": "2026-04-22T08:20:00Z"
    }
  ],
  "error": null,
  "meta": {
    "nextCursor": "bkt_01J9PENDINGGGGGGGGGGGGGGGG",
    "limit": 50
  }
}