Skip to main content
GET
/
boxes
List boxes
curl --request GET \
  --url https://ascii.dev/api/box/v1/boxes \
  --header 'Authorization: Bearer <token>'
{
  "ok": true,
  "type": "box.list",
  "boxes": [
    {
      "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.

Query Parameters

​
limit
integer
default:100

Maximum items to return.

Required range: 1 <= x <= 200
​
cursor
string | null

Opaque pagination cursor returned as pageInfo.nextCursor.

​
sort
enum<string>
default:desc

Sort direction for cursor pagination.

Available options:
asc,
desc
​
state
string

Comma-separated Box state filter, for example ready,idle,running.

Response

Boxes owned by the authenticated Box user.

​
ok
boolean
required
Example:

true

​
type
string
required

Stable success envelope discriminator added by v1.

Allowed value: "box.list"
​
boxes
object[]
required
​
pageInfo
object