Skip to main content
GET
List sandboxes

Autorisations

Authorization
string
header
défaut:Bearer {API_ACCESS_TOKEN}
requis

CoreWeave API access token sent as a bearer token.

Paramètres de requête

pageSize
integer<int32>
pageToken
string
tags
string[]

Filter: sandboxes matching all tags (AND).

state
enum<string>

Filter: only sandboxes in this state (STATE_UNSPECIFIED = any).

Options disponibles:
STATE_UNSPECIFIED,
STATE_CREATING,
STATE_RUNNING,
STATE_COMPLETED,
STATE_FAILED,
STATE_TERMINATING,
STATE_TERMINATED,
STATE_PENDING,
STATE_PAUSED,
STATE_PREPARING
showTerminated
boolean

Include terminal sandboxes within the retention window. Defaults to active-only.

runnerIds
string[]

Filter: sandboxes on any of these runners.

volumeIds
string[]

Filter: sandboxes with any of these registered Volumes attached.

sortDirection
enum<string>

Direction of the creation-time ordering, with sandbox_id breaking ties. Unspecified means descending: newest first. A page_token must be reused with the direction that produced it.

Options disponibles:
SORT_DIRECTION_UNSPECIFIED,
SORT_DIRECTION_DESCENDING,
SORT_DIRECTION_ASCENDING

Réponse

OK

sandboxes
object[]
nextPageToken
string