BucktDocs

Get bucket

GET/v1/buckets/{id}buckets:readSDK: buckets.get

Returns the bucket object, including current provisioning state, settings, and bandwidth/storage usage.

Path parameters

NameTypeDefaultDescription
idrequiredstringThe bucket ID returned from create or list.

Example request

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

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

const bucket = await client.buckets.get("bkt_01H8XYZABCDEFGHJKMNPQRSTVW");

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"
  },
  "error": null,
  "meta": null
}