v1

latestOpenAPI 3.1.02026-07-22304756.7 KB

Box

Update box

patch/boxes/{boxId}

Request body

namestring

New display name. Empty strings are rejected; longer names are truncated to 120 chars by the backend.

ttlSecondsinteger nullable

New archival TTL. null disables auto-stop.

subdomainstring

Rename the Box's stable subdomain (the <subdomain>.on.ascii.dev label). Lowercase letters, digits and hyphens; no leading/trailing/double hyphens; cannot end in -desktop or -<number> (reserved for the desktop and hosted-port URLs). Must be globally unique. The base URL, desktop URL and every live host <port> URL are re-pointed to the new name with no downtime and their access tokens preserved; the old URLs stop resolving. On a transient routing error the rename is saved but returns 502 gateway_error - retry with the same value to finish activating routes.

Example request

{
  "name": "Customer support run",
  "ttlSeconds": 7200
}

Response

Updated box details.

okboolean required

typestring required

Stable success envelope discriminator added by v1.

Example response

{
  "ok": true,
  "type": "box.info",
  "box": {
    "id": "bx_23456789",
    "name": "Box 2026-05-31 12:00"
  }
}