API referenceBuckets
Delete a bucket
Archives a bucket and soft-deletes all of its objects in a single transaction, so their bytes immediately stop counting toward your storage usage.
Archives a bucket and soft-deletes all of its objects in a single transaction, so their bytes immediately stop counting toward your storage usage. The default bucket and the reserved attachments bucket are protected and cannot be deleted — both return 409. Returns no content on success. Requires buckets:write.
Scope: buckets:write. Send the API key as a bearer token; Scopes lists what each one reaches.
Request
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
bucketId | string | yes | Bucket identifier (buk_*). |
Response
200 Success. Body: application/json, Bucket.
| Field | Type | Required | Description |
|---|---|---|---|
object | "bucket" | yes | |
id | string | yes | Bucket identifier (buk_*). |
name | string | yes | |
displayName | string or null | no | |
description | string or null | no | |
isDefault | boolean | yes | |
status | "active", "archived" | yes | |
usedBytes | integer | yes | (minimum 0) |
objectCount | integer | yes | (minimum 0) |
metadata | object or null | no | |
createdAt | string (date-time) | yes | |
updatedAt | string (date-time) | yes |
Errors
Every error has the same body, {"error": {"type", "code", "message", "param"}}; branch on code. Errors lists every code.
| Status | Meaning |
|---|---|
400 | The request is malformed or a value is invalid (invalid_request, invalid_domain, idempotency_key_mismatch). |
401 | The API key is missing or invalid. |
403 | The key lacks the scope this endpoint needs (scope_missing) or may not do this (not_permitted). |
404 | No such resource in this account (resource_not_found). |
409 | The resource already exists or its state does not allow this (duplicate_resource or a condition-specific code). |
422 | The request is well-formed but a field failed validation (validation_failed). |
429 | Rate limit, plan limit, budget or spend cap reached (rate_limited, plan_limit_reached, budget_exceeded, spend_cap_reached). |
500 | An unexpected error; retry with backoff, then contact support (internal_error). |