Skip to main content
GET
List active sandboxes

Authorizations

Authorization
string
header
required

API Key or Access Token, always sent as Authorization: Bearer <token>. The gateway recognizes the token type automatically.

Query Parameters

page
integer
default:1

Page number, starting from 1; default 1

Required range: x >= 1
page_size
integer
default:20

Items per page; default 20, maximum 100

Required range: 1 <= x <= 100
idc_name
string

Filter by data center name, e.g. us-denver-1

state
enum<string>[]

Filter by external state. Repeatable; multiple values are OR-ed.

Available options:
provisioning,
running,
failed
metadata[key]
string

Filter by customer metadata key/value, e.g. metadata[job_id]=job-9182. Repeatable; multiple filters are AND-ed.

Response

Query succeeded

request_id
string
required

Request tracing ID

total
integer
required

Total number of active sandboxes

page
integer
required
page_size
integer
required
items
object[]
required