Update a bucket

Updates a bucket's displayName, description, or metadata and returns the refreshed record with live usage.

Endpoint

PATCH https://api.dairo.app/v1/buckets/{bucketId}

Updates a bucket's displayName, description, or metadata and returns the refreshed record with live usage. Only the fields you include are changed; a metadata value replaces the stored object wholesale rather than merging into it. A bucket's name and its isDefault flag are immutable and cannot be changed here — sending an empty body returns the bucket unchanged. Requires buckets:write.

Scope: buckets:write. Send the API key as a bearer token; Scopes lists what each one reaches.

Request

cURL

curl -X PATCH "https://api.dairo.app/v1/buckets/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer $DAIRO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Path parameters

Name	Type	Required	Description
`bucketId`	string	yes	Bucket identifier (buk_*).

Body

Required, application/json: UpdateBucketRequest.

Field	Type	Required	Description
`displayName`	string or null	no	(max length 256)
`description`	string or null	no	(max length 1024)
`metadata`	object or null	no

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

200

{
  "object": "bucket",
  "id": "string",
  "name": "Ada Lovelace",
  "displayName": null,
  "description": null,
  "isDefault": true,
  "status": "active",
  "usedBytes": 0,
  "objectCount": 0,
  "metadata": {},
  "createdAt": "2026-10-19T09:30:00Z",
  "updatedAt": "2026-10-19T09:30:00Z"
}

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`).

Request

Path parameters

Body

Response

Errors

On this page