Skip to main content
GET
List sandboxes
List sandboxes in your current project with GET /sandboxes. Use GET /archived-sandboxes to list terminated sandboxes. Each sandbox record includes the auto_resume boolean. Check it alongside status to distinguish a suspended sandbox that wakes on traffic from one that requires explicit resume.

List sandboxes by status

GET /sandboxes returns sandboxes that haven’t terminated. Omit status to include every non-terminated lifecycle state, or filter with status=running, status=suspended, or status=resume_failed. status=suspended includes only fully suspended sandboxes, excluding those still suspending or in resume_failed. Resume-failed sandboxes remain in the unfiltered active list; they are not archived. Use status=resume_failed to find failures for inspection, then retry explicitly with a bound. The endpoint doesn’t accept status=terminated.

List terminated sandboxes

An archived sandbox is a retained record of a terminated sandbox. Use GET /archived-sandboxes to list these records in your current project. The default retention window is 48 hours after termination; the archive doesn’t retain history indefinitely. This request lists up to 100 terminated sandboxes, newest archived first:
Each entry in the response’s sandboxes array includes status: "terminated" and archived_at, a Unix timestamp in milliseconds. Use these query parameters to paginate the archive: When next_cursor is null, you’ve reached the last page. Use cursors from /archived-sandboxes only with that endpoint.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limit
integer

Maximum number of sandboxes to return. Defaults to 100.

Required range: x >= 1
cursor
string

Base64-encoded pagination cursor returned by a previous list call.

direction
enum<string>

Pagination direction for the provided cursor.

Available options:
forward,
backward
status
enum<string>

Optional sandbox status filter. running returns running sandboxes; suspended returns fully suspended sandboxes, excluding those suspending or resume_failed; resume_failed returns recoverable resume failures. Omit the filter to include all non-terminated states. Use GET /archived-sandboxes for terminated sandboxes.

Available options:
running,
suspended,
resume_failed

Response

List of sandboxes retrieved successfully

sandboxes
object[]
required
prev_cursor
string | null
next_cursor
string | null