Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Hiloop API key sent as an HTTP Bearer token.

Query Parameters

state
enum<string>[]

Observed-state filters combined with OR. Empty returns sandboxes in every state.

Available options:
requested,
reserved,
materializing,
ready,
running,
stopped,
terminating,
failed,
terminated,
quarantined,
attention
page_size
integer<uint32>

Maximum number of sandboxes to return. Zero uses the server default; the server caps it at 100.

Required range: x <= 100
page_token
string

Opaque token returned by a previous response. It binds the organization and every filter argument; changing any argument is rejected. Empty starts the first page.

name
string

Optional exact name filter. Clients resolve a name within the selected project through this filter, then use the returned server id for id-addressed routes.

Required string length: 1 - 63
Pattern: ^[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$
metadata
object

Optional exact metadata entries. Every supplied key and value must match. At most 50 entries, keys at most 128 characters, and at most 4096 bytes of total value content.

Response

OK

sandboxes
object[]
required

The sandboxes on this page, ordered by created_at descending then id descending.

One organization-scoped sandbox and its observed state.

next_page_token
string
required

Token for the next page. Empty means this is the final page.