Skip to main content
GET
/
boxes
/
{boxId}
Get box
curl --request GET \
  --url https://ascii.dev/api/box/v1/boxes/{boxId} \
  --header 'Authorization: Bearer <token>'
{
  "ok": true,
  "type": "box.info",
  "box": {
    "id": "bx_23456789",
    "name": "Box 2026-05-31 12:00",
    "state": "idle",
    "url": "https://machine.on.ascii.dev",
    "ip": "203.0.113.10",
    "createdAt": "2026-05-31T12:00:00Z",
    "updatedAt": "2026-05-31T12:05:00Z",
    "archiveAfter": "2026-05-31T13:00:00Z",
    "desktopAvailable": true,
    "desktopUrl": "https://desktop.example/stream.html?token=redacted",
    "snapshotAvailable": false,
    "snapshotCompletedAt": null
  }
}

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

Response

Box details.

​
ok
boolean
required
Example:

true

​
type
string
required

Stable success envelope discriminator added by v1.

Example:

"box.info"

​
box
object
required