Error
A valid request URL is required to generate request examples{
"items": [
{
"cpu_millicores": 123,
"created_at": "<string>",
"created_by": "<string>",
"dataplane_url": "<string>",
"delete_after_stop_seconds": 123,
"fs_capacity_bytes": 123,
"id": "<string>",
"idle_ttl_seconds": 123,
"labels": {},
"mem_bytes": 123,
"mount_config": {
"auth": {
"aws": {
"access_key_id": {
"type": "plaintext",
"is_set": true,
"value": "<string>"
},
"secret_access_key": {
"type": "plaintext",
"is_set": true,
"value": "<string>"
}
},
"gcp": {
"service_account_json": {
"type": "plaintext",
"is_set": true,
"value": "<string>"
}
}
},
"mounts": [
{
"id": "<string>",
"mount_path": "<string>",
"s3": {
"bucket": "<string>",
"region": "<string>",
"endpoint_url": "<string>",
"path_style": true,
"prefix": "<string>"
},
"type": "s3",
"cache": {
"max_size_bytes": 1,
"writeback_seconds": 1
},
"read_only": true,
"contexthub": {
"repo": "<string>",
"initial_pull_only": true
},
"gcs": {
"bucket": "<string>",
"prefix": "<string>"
},
"git": {
"remote_url": "<string>",
"ref": {
"name": "<string>",
"type": "branch"
},
"refresh_interval_seconds": 2
}
}
]
},
"name": "<string>",
"preserve_memory_on_stop": true,
"proxy_config": {
"access_control": {
"allow_list": [
"<string>"
],
"deny_list": [
"<string>"
]
},
"callbacks": [
{
"match_hosts": [
"<string>"
],
"ttl_seconds": 1830,
"url": "<string>",
"full_request": true,
"request_headers": [
{
"name": "<string>",
"type": "plaintext",
"is_set": true,
"value": "<string>"
}
]
}
],
"description": "<string>",
"no_proxy": [
"<string>"
],
"rules": [
{
"name": "<string>",
"aws": {
"access_key_id": {
"type": "plaintext",
"is_set": true,
"value": "<string>"
},
"secret_access_key": {
"type": "plaintext",
"is_set": true,
"value": "<string>"
}
},
"description": "<string>",
"enabled": true,
"env_vars": {},
"gcp": {
"scopes": [
"<string>"
],
"service_account_json": {
"type": "plaintext",
"is_set": true,
"value": "<string>"
}
},
"headers": [
{
"name": "<string>",
"type": "plaintext",
"is_set": true,
"value": "<string>"
}
],
"match_hosts": [
"<string>"
],
"match_paths": [
"<string>"
],
"type": "<string>"
}
]
},
"size_class": "<string>",
"snapshot_id": "<string>",
"status": "<string>",
"status_message": "<string>",
"stopped_at": "<string>",
"updated_at": "<string>",
"updated_by": "<string>",
"vcpus": 123
}
],
"next_cursor": "<string>",
"offset": 123,
"sandboxes": [
{
"cpu_millicores": 123,
"created_at": "<string>",
"created_by": "<string>",
"dataplane_url": "<string>",
"delete_after_stop_seconds": 123,
"fs_capacity_bytes": 123,
"id": "<string>",
"idle_ttl_seconds": 123,
"labels": {},
"mem_bytes": 123,
"mount_config": {
"auth": {
"aws": {
"access_key_id": {
"type": "plaintext",
"is_set": true,
"value": "<string>"
},
"secret_access_key": {
"type": "plaintext",
"is_set": true,
"value": "<string>"
}
},
"gcp": {
"service_account_json": {
"type": "plaintext",
"is_set": true,
"value": "<string>"
}
}
},
"mounts": [
{
"id": "<string>",
"mount_path": "<string>",
"s3": {
"bucket": "<string>",
"region": "<string>",
"endpoint_url": "<string>",
"path_style": true,
"prefix": "<string>"
},
"type": "s3",
"cache": {
"max_size_bytes": 1,
"writeback_seconds": 1
},
"read_only": true,
"contexthub": {
"repo": "<string>",
"initial_pull_only": true
},
"gcs": {
"bucket": "<string>",
"prefix": "<string>"
},
"git": {
"remote_url": "<string>",
"ref": {
"name": "<string>",
"type": "branch"
},
"refresh_interval_seconds": 2
}
}
]
},
"name": "<string>",
"preserve_memory_on_stop": true,
"proxy_config": {
"access_control": {
"allow_list": [
"<string>"
],
"deny_list": [
"<string>"
]
},
"callbacks": [
{
"match_hosts": [
"<string>"
],
"ttl_seconds": 1830,
"url": "<string>",
"full_request": true,
"request_headers": [
{
"name": "<string>",
"type": "plaintext",
"is_set": true,
"value": "<string>"
}
]
}
],
"description": "<string>",
"no_proxy": [
"<string>"
],
"rules": [
{
"name": "<string>",
"aws": {
"access_key_id": {
"type": "plaintext",
"is_set": true,
"value": "<string>"
},
"secret_access_key": {
"type": "plaintext",
"is_set": true,
"value": "<string>"
}
},
"description": "<string>",
"enabled": true,
"env_vars": {},
"gcp": {
"scopes": [
"<string>"
],
"service_account_json": {
"type": "plaintext",
"is_set": true,
"value": "<string>"
}
},
"headers": [
{
"name": "<string>",
"type": "plaintext",
"is_set": true,
"value": "<string>"
}
],
"match_hosts": [
"<string>"
],
"match_paths": [
"<string>"
],
"type": "<string>"
}
]
},
"size_class": "<string>",
"snapshot_id": "<string>",
"status": "<string>",
"status_message": "<string>",
"stopped_at": "<string>",
"updated_at": "<string>",
"updated_by": "<string>",
"vcpus": 123
}
]
}{
"detail": {
"error": "<string>",
"error_id": "<string>",
"message": "<string>"
}
}{
"detail": {
"error": "<string>",
"error_id": "<string>",
"message": "<string>"
}
}{
"detail": {
"error": "<string>",
"error_id": "<string>",
"message": "<string>"
}
}{
"detail": {
"error": "<string>",
"error_id": "<string>",
"message": "<string>"
}
}List sandboxes
List sandboxes for the authenticated tenant, with optional filtering, sorting, and pagination. Page with page_size and cursor: replay the response’s next_cursor until it comes back null, which is the only signal that no pages remain. Cursors are opaque and only valid on this endpoint; do not parse or construct one.
GET
/
api
/
v2
/
sandboxes
/
boxes
Error
A valid request URL is required to generate request examples{
"items": [
{
"cpu_millicores": 123,
"created_at": "<string>",
"created_by": "<string>",
"dataplane_url": "<string>",
"delete_after_stop_seconds": 123,
"fs_capacity_bytes": 123,
"id": "<string>",
"idle_ttl_seconds": 123,
"labels": {},
"mem_bytes": 123,
"mount_config": {
"auth": {
"aws": {
"access_key_id": {
"type": "plaintext",
"is_set": true,
"value": "<string>"
},
"secret_access_key": {
"type": "plaintext",
"is_set": true,
"value": "<string>"
}
},
"gcp": {
"service_account_json": {
"type": "plaintext",
"is_set": true,
"value": "<string>"
}
}
},
"mounts": [
{
"id": "<string>",
"mount_path": "<string>",
"s3": {
"bucket": "<string>",
"region": "<string>",
"endpoint_url": "<string>",
"path_style": true,
"prefix": "<string>"
},
"type": "s3",
"cache": {
"max_size_bytes": 1,
"writeback_seconds": 1
},
"read_only": true,
"contexthub": {
"repo": "<string>",
"initial_pull_only": true
},
"gcs": {
"bucket": "<string>",
"prefix": "<string>"
},
"git": {
"remote_url": "<string>",
"ref": {
"name": "<string>",
"type": "branch"
},
"refresh_interval_seconds": 2
}
}
]
},
"name": "<string>",
"preserve_memory_on_stop": true,
"proxy_config": {
"access_control": {
"allow_list": [
"<string>"
],
"deny_list": [
"<string>"
]
},
"callbacks": [
{
"match_hosts": [
"<string>"
],
"ttl_seconds": 1830,
"url": "<string>",
"full_request": true,
"request_headers": [
{
"name": "<string>",
"type": "plaintext",
"is_set": true,
"value": "<string>"
}
]
}
],
"description": "<string>",
"no_proxy": [
"<string>"
],
"rules": [
{
"name": "<string>",
"aws": {
"access_key_id": {
"type": "plaintext",
"is_set": true,
"value": "<string>"
},
"secret_access_key": {
"type": "plaintext",
"is_set": true,
"value": "<string>"
}
},
"description": "<string>",
"enabled": true,
"env_vars": {},
"gcp": {
"scopes": [
"<string>"
],
"service_account_json": {
"type": "plaintext",
"is_set": true,
"value": "<string>"
}
},
"headers": [
{
"name": "<string>",
"type": "plaintext",
"is_set": true,
"value": "<string>"
}
],
"match_hosts": [
"<string>"
],
"match_paths": [
"<string>"
],
"type": "<string>"
}
]
},
"size_class": "<string>",
"snapshot_id": "<string>",
"status": "<string>",
"status_message": "<string>",
"stopped_at": "<string>",
"updated_at": "<string>",
"updated_by": "<string>",
"vcpus": 123
}
],
"next_cursor": "<string>",
"offset": 123,
"sandboxes": [
{
"cpu_millicores": 123,
"created_at": "<string>",
"created_by": "<string>",
"dataplane_url": "<string>",
"delete_after_stop_seconds": 123,
"fs_capacity_bytes": 123,
"id": "<string>",
"idle_ttl_seconds": 123,
"labels": {},
"mem_bytes": 123,
"mount_config": {
"auth": {
"aws": {
"access_key_id": {
"type": "plaintext",
"is_set": true,
"value": "<string>"
},
"secret_access_key": {
"type": "plaintext",
"is_set": true,
"value": "<string>"
}
},
"gcp": {
"service_account_json": {
"type": "plaintext",
"is_set": true,
"value": "<string>"
}
}
},
"mounts": [
{
"id": "<string>",
"mount_path": "<string>",
"s3": {
"bucket": "<string>",
"region": "<string>",
"endpoint_url": "<string>",
"path_style": true,
"prefix": "<string>"
},
"type": "s3",
"cache": {
"max_size_bytes": 1,
"writeback_seconds": 1
},
"read_only": true,
"contexthub": {
"repo": "<string>",
"initial_pull_only": true
},
"gcs": {
"bucket": "<string>",
"prefix": "<string>"
},
"git": {
"remote_url": "<string>",
"ref": {
"name": "<string>",
"type": "branch"
},
"refresh_interval_seconds": 2
}
}
]
},
"name": "<string>",
"preserve_memory_on_stop": true,
"proxy_config": {
"access_control": {
"allow_list": [
"<string>"
],
"deny_list": [
"<string>"
]
},
"callbacks": [
{
"match_hosts": [
"<string>"
],
"ttl_seconds": 1830,
"url": "<string>",
"full_request": true,
"request_headers": [
{
"name": "<string>",
"type": "plaintext",
"is_set": true,
"value": "<string>"
}
]
}
],
"description": "<string>",
"no_proxy": [
"<string>"
],
"rules": [
{
"name": "<string>",
"aws": {
"access_key_id": {
"type": "plaintext",
"is_set": true,
"value": "<string>"
},
"secret_access_key": {
"type": "plaintext",
"is_set": true,
"value": "<string>"
}
},
"description": "<string>",
"enabled": true,
"env_vars": {},
"gcp": {
"scopes": [
"<string>"
],
"service_account_json": {
"type": "plaintext",
"is_set": true,
"value": "<string>"
}
},
"headers": [
{
"name": "<string>",
"type": "plaintext",
"is_set": true,
"value": "<string>"
}
],
"match_hosts": [
"<string>"
],
"match_paths": [
"<string>"
],
"type": "<string>"
}
]
},
"size_class": "<string>",
"snapshot_id": "<string>",
"status": "<string>",
"status_message": "<string>",
"stopped_at": "<string>",
"updated_at": "<string>",
"updated_by": "<string>",
"vcpus": 123
}
]
}{
"detail": {
"error": "<string>",
"error_id": "<string>",
"message": "<string>"
}
}{
"detail": {
"error": "<string>",
"error_id": "<string>",
"message": "<string>"
}
}{
"detail": {
"error": "<string>",
"error_id": "<string>",
"message": "<string>"
}
}{
"detail": {
"error": "<string>",
"error_id": "<string>",
"message": "<string>"
}
}Authorizations
API KeyTenant IDBearer Auth
Query Parameters
Number of results per page
Opaque pagination cursor from a prior response's next_cursor
Deprecated: use page_size. Maximum number of results
Deprecated: use cursor. Pagination offset
Filter by name substring
Filter by status (provisioning, ready, failed, stopped, deleting)
Filter by creator identity. Only 'me' is supported.
Filter by label. Repeatable; all must match. Use 'key' to match on key presence or 'key=value' for equality.
Sort column (name, status, created_at, stopped_at, idle_ttl_seconds, delete_after_stop_seconds)
Sort direction (asc, desc)
Deprecated: use sort_order. Sort direction (asc, desc)
Response
OK
This page of sandboxes.
Show child attributes
Show child attributes
Cursor for the next page, or null on the last page. A non-null value is the only signal that more pages exist. Treat it as opaque.
Deprecated: use next_cursor. Offset to request for the next page, or 0 when no pages remain.
Deprecated: use items. Duplicates items.
Show child attributes
Show child attributes
Was this page helpful?
⌘I