Sign in
Box

Get box

Poll this endpoint after create, stop, resume, or fork operations.

get/boxes/{boxId}

Response

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"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.