Cubicle

List the caller's Boxes

GET
/v1/boxes

Returns every Box in every organization where the caller is an active member, as a bare array sorted by organization name and then creation time. An API key sees only its own organization's Boxes.

Each entry is a Box with three more fields, described below: viewer, grants and openVpnSessions. Boxes being deleted are listed with deletion: "pending" until their Node has removed them.

To list one organization's Boxes, use List an organization's Boxes.

Authorization

headerAuthorizationBearer <token>

A service account API key (cbk_…), used directly as the bearer token. read keys may call only GET routes.

Response Body

The caller's Boxes, each with its grants and the caller's access.

application/json
  1. response
[index: integer]?
Example Request
curl -X GET 'https://api.cubicle.sh/v1/boxes'
Example Response
[  {    "storage": {      "enabled": true,      "status": "base",      "checkpointId": null,      "checkpointAt": null,      "current": false,      "processedBytes": 0,      "totalBytes": 0,      "error": null,      "retryAt": null    },    "id": "0f6c2a5e-3b1d-4c8e-9a7f-2d4e6b8c1a3f",    "org": {      "id": "6b1f3d2a-8c4e-4f7a-9b2d-1e5c7a9f3b6d",      "name": "acme"    },    "name": "job-1",    "baseImage": "default",    "node": {      "id": "c3a9e1f7-5b2d-4a8c-8e6f-0d1b3c5e7a9f",      "name": "node-1",      "healthy": true    },    "spec": {      "vcpus": 2,      "memoryMiB": 2048,      "diskGiB": 12    },    "sourceSnapshotId": null,    "desired": {      "state": "running",      "generation": 1    },    "observed": {      "state": "running",      "generation": 1,      "observedAt": "2026-11-05T10:15:04.000Z",      "ageSeconds": 2,      "fresh": true,      "error": null    },    "state": "running",    "hibernateAt": "2026-11-05T11:14:58.000Z",    "hibernationRetryAt": null,    "pooled": false,    "expiresAt": null,    "restartRequired": false,    "connectionGeneration": 1,    "privateIp": "10.20.30.17",    "console": {      "ready": true,      "reason": null    },    "ssh": {      "ready": true,      "reason": null    },    "deletion": null,    "createdAt": "2026-11-05T10:14:21.000Z",    "viewer": {      "role": "member",      "granted": true    },    "grants": [      {        "userId": "2c4e6a8b-0d1f-4e3a-9b5c-7d9f1b3d5e7a",        "identity": "ada@example.com",        "status": "active",        "guestAccount": "jv_2c4e6a8b0d1f",        "desiredRevision": 2,        "appliedRevision": 2,        "accountStatus": "applied"      }    ],    "openVpnSessions": 1  }]