Skip to main content
POST
Look up the status of a batch of sandboxes

Authorizations

X-API-Key
string
header
required

Body

application/json
sandbox_ids
string[]
required

Sandbox ids to look up, in either public form. Duplicates are collapsed. Page through a larger backlog a batch at a time.

Required array length: 1 - 1000 elements

Public sandbox ID: a bare UUID, or the region-tagged form sb-<region>-<uuid> (e.g. sb-use-1b4e28ba-…). Treat as an opaque string; the tagged form routes the request to the sandbox's home region. Endpoints accept both forms interchangeably.

Pattern: ^(sb-[a-z0-9]+-)?[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Response

Status for every id the team owns, and the rest as unknown.

sandboxes
object[]
required

One entry per id this team owns, deleted included.

unknown
string[]
required

Ids with no sandbox for this team: never created, or belonging to another team. Echoed exactly as submitted.

Public sandbox ID: a bare UUID, or the region-tagged form sb-<region>-<uuid> (e.g. sb-use-1b4e28ba-…). Treat as an opaque string; the tagged form routes the request to the sandbox's home region. Endpoints accept both forms interchangeably.

Pattern: ^(sb-[a-z0-9]+-)?[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$