Leap0

List sandboxes

List sandboxes for the authenticated organization. Results can be filtered by state and sorted by creation time or current state.

GET
/v1/sandboxes

List sandboxes for the authenticated organization. Results can be filtered by state and sorted by creation time or current state.

Authorization

BearerAuth
AuthorizationBearer <token>

API key passed as a Bearer token in the Authorization header. Alternatively, use the leap0-authorization header.

In: header

Query Parameters

state?string

Filter results by sandbox state.

Value in"starting" | "snapshotting" | "running" | "paused" | "unpausing" | "deleting"
sort?string

Field used to sort results.

Default"created_at"
Value in"created_at" | "state"
order-by?string

Sort direction.

Default"desc"
Value in"asc" | "desc"
page?integer

1-based results page.

Default1
Range1 <= value
page-size?integer

Number of items per page.

Default20
Range1 <= value <= 100

Response Body

application/json

application/json

application/json

curl -X GET "https://api.leap0.dev/v1/sandboxes"
{  "items": [    {      "id": "sbx-abc123",      "template_id": "string",      "pod_id": "string",      "state": "starting",      "launch_time": "2019-08-24T14:15:22Z",      "state_change_time": "2019-08-24T14:15:22Z",      "timeout_at": 0,      "created_at": "2019-08-24T14:15:22Z"    }  ],  "total_items": 0}
{  "message": "string",  "errors": [    {      "field": "string",      "error": "string"    }  ]}
{  "message": "string"}