Skip to main content
Every file and folder call is scoped to a bucket. Two read-only bucket operations are published: they let a key discover the buckets it may target and read how much each one stores. Everything that changes a bucket — creation, configuration, deletion — remains a dashboard action.

Operations

List accessible buckets

An illustrative response:
Values are illustrative. The list is not paginated: it returns every bucket the key can reach in one response. Notes:
  • A key restricted to specific buckets sees only those buckets in the list. Out-of-scope buckets are filtered out silently; there is no separate error.
  • datacenterId is the only location signal on bucket records. Available locations are chosen at bucket creation in the dashboard, and the platform’s datacenter and region routes are session-only — they are not reachable with an API key. See Data residency.
  • The default bucket (name equal to code) is created automatically at provisioning and cannot be deleted.

Read bucket size

An illustrative response:
Notes:
  • The size counts non-deleted files only. Files in trash are excluded, so the value can drop when a hard delete purges trash.
  • The size reflects stored content in the bucket, not the plan’s capacity ceiling. Plan capacity is visible in the dashboard.
  • An unknown bucket, or one outside the caller’s tenant, returns 404.
  • A restricted key asking for a bucket outside its scope returns 403 API_BUCKET_SCOPE_DENIED.

What stays in the dashboard

Do not build against bucket routes that are not in this reference. Bucket creation, update, deletion, and provisioning are session-only: an API-key call to them fails, and the routes are not a stable contract.

Buckets, folders, and files

The storage hierarchy and how IDs are used.

Files

File operations within a bucket.

Folders

Folder operations within a bucket.

Limits and quotas

Trial and plan caps that apply to every operation.