Skip to main content
PATCH
/
boxes
/
{boxId}
Update box
curl --request PATCH \
  --url https://ascii.dev/api/box/v1/boxes/{boxId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "ttlSeconds": 1296000
}
'
{
  "ok": true,
  "type": "box.info",
  "box": {
    "id": "<string>",
    "name": "<string>",
    "desktopAvailable": true,
    "snapshotAvailable": true,
    "url": "<string>",
    "ip": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "archiveAfter": "2023-11-07T05:31:56Z",
    "desktopUrl": "<string>",
    "snapshotCompletedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization
string
header
required

Box API key in the form box_.... Create and rotate keys in the Box dashboard or through the v1 API key endpoints.

Path Parameters

boxId
string
required

Public Box id returned by create/list/get box calls.

Pattern: ^bx_[23456789abcdefghjkmnpqrstuvwxyz]{8}$

Body

application/json
name
string

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

Required string length: 1 - 120
ttlSeconds
integer | null

New archival TTL. null disables auto-stop.

Required range: 1 <= x <= 2592000

Response

Updated box details.

ok
boolean
required
Example:

true

type
string
required

Stable success envelope discriminator added by v1.

Example:

"box.info"

box
object
required