curl --silent --show-error --fail-with-body --request GET \
--url 'https://api.sandbox.stateset.app/api/v1/sandboxes' \
--header "Authorization: ApiKey $STATESET_SANDBOX_API_KEY"
{
"sandboxes": [
{
"sandbox_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"org_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"session_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"status": "creating",
"allocated_vcpu": 1.5,
"allocated_memory_gib": 1.5,
"created_at": "2026-08-31T14:22:05Z",
"expires_at": "2026-08-31T14:22:05Z",
"max_expires_at": "2026-08-31T14:22:05Z",
"max_lifetime_seconds": 250,
"remaining_extend_seconds": 250,
"lifetime_used_seconds": 250,
"lifetime_used_percent": 7.5
}
],
"pagination": {
"limit": 20,
"offset": 1,
"total": 102,
"has_more": true
}
}
List sandboxes for the authenticated organization
Paginated list of sandboxes
GET
/
api
/
v1
/
sandboxes
curl --silent --show-error --fail-with-body --request GET \
--url 'https://api.sandbox.stateset.app/api/v1/sandboxes' \
--header "Authorization: ApiKey $STATESET_SANDBOX_API_KEY"
{
"sandboxes": [
{
"sandbox_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"org_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"session_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"status": "creating",
"allocated_vcpu": 1.5,
"allocated_memory_gib": 1.5,
"created_at": "2026-08-31T14:22:05Z",
"expires_at": "2026-08-31T14:22:05Z",
"max_expires_at": "2026-08-31T14:22:05Z",
"max_lifetime_seconds": 250,
"remaining_extend_seconds": 250,
"lifetime_used_seconds": 250,
"lifetime_used_percent": 7.5
}
],
"pagination": {
"limit": 20,
"offset": 1,
"total": 102,
"has_more": true
}
}
Confirm your deployment before running this request. This page describes an API contract;
a published reference does not establish hosted availability. Check the dated
host report and obtain your deployment URL and credentials.
Replace the example host if your provisioned service uses a different URL.
Query parameters
integer
Max results (1-100, default 20)
integer
Results offset (default 0)
string
Comma-separated state filter (e.g. running,paused)
Response
object
object[]
required
Show sandboxes
Show sandboxes
string (uuid)
required
string
required
string
required
string
required
Allowed values:
'creating', 'running', 'paused', 'terminating', 'terminated', 'error'.number
Allocated vCPU cores.
number
Allocated memory in GiB.
string (date-time)
required
string (date-time)
required
string (date-time)
required
integer
required
integer
required
integer
required
number
required
Status codes
| Code | Meaning |
|---|---|
200 | Paginated list of sandboxes |
Using this contract
Read the source OpenAPI document for declared schemas and alternatives. This page also includes documented corrections from the spec overlays. Example IDs and values are illustrative; replace them with records from your workspace.curl --silent --show-error --fail-with-body --request GET \
--url 'https://api.sandbox.stateset.app/api/v1/sandboxes' \
--header "Authorization: ApiKey $STATESET_SANDBOX_API_KEY"
{
"sandboxes": [
{
"sandbox_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"org_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"session_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"status": "creating",
"allocated_vcpu": 1.5,
"allocated_memory_gib": 1.5,
"created_at": "2026-08-31T14:22:05Z",
"expires_at": "2026-08-31T14:22:05Z",
"max_expires_at": "2026-08-31T14:22:05Z",
"max_lifetime_seconds": 250,
"remaining_extend_seconds": 250,
"lifetime_used_seconds": 250,
"lifetime_used_percent": 7.5
}
],
"pagination": {
"limit": 20,
"offset": 1,
"total": 102,
"has_more": true
}
}
Last modified on September 21, 2026