Skip to main content
GET
List Sandboxes
Returns the sandboxes owned by the authenticated API key, newest first. Killed sandboxes are left out unless state asks for them. Results come in a sandboxes array, with the total that match and a next_token while more pages remain.

Query Parameters

string
States to list: live, paused, killed, or all. Repeat the parameter or separate values with commas to list several (?state=live&state=paused, ?state=paused,killed). running is accepted as live, and creating, which no sandbox is ever reported in, lists none. Omit it to list every state but killed. An unknown state is refused with 400.
string
Lists only sandboxes whose metadata holds every given key with exactly the given value. Send a JSON object of strings ({"user":"u1"}) or key=value pairs joined by & (user=u1&env=prod), URL-encoded as the parameter’s value. In the key=value form, URL-encode each key and value first, as in a query string: an unencoded + reads as a space. A filter that can’t be read is refused with 400 rather than ignored.
integer
default:"100"
Page size. Capped at 1000.
string
The next_token of the previous page, to fetch the page after it. Send the same filters with it.
integer
default:"0"
Matching sandboxes to skip. Ignored when next_token is sent. Prefer next_token: offsets shift when sandboxes are created or killed between pages, so a page can repeat or skip one.

Response

Sandbox[]
Array of Sandbox objects, newest first. May be empty.
integer
How many sandboxes match the filters, across all pages.
string | null
Cursor for the next page. null on the last page.

Example

Response

Error Responses