Error
A valid request URL is required to generate request examples{
"items": [
{
"created_at": "<string>",
"created_by": "<string>",
"description": "<string>",
"docker_image": "<string>",
"fs_capacity_bytes": 123,
"fs_used_bytes": 123,
"id": "<string>",
"image_digest": "<string>",
"included": [
"mounts"
],
"labels": {},
"memory_snapshot_size_bytes": 123,
"mount_config": {
"auth": {
"aws": {
"role_arn": "<string>",
"subject_scope": "<string>"
},
"azure": {
"tenant_id": "<string>",
"client_id": "<string>",
"subject_scope": "<string>"
},
"gcp": {
"workload_identity_provider": "<string>",
"service_account_email": "<string>",
"subject_scope": "<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
},
"encryption": {
"kms_key": "<string>"
},
"read_only": true,
"azure_blob": {
"container": "<string>",
"storage_account": "<string>",
"prefix": "<string>"
},
"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>",
"proxy_config": {
"access_control": {
"allow_list": [
"<string>"
],
"deny_list": [
"<string>"
]
},
"callbacks": [
{
"ttl_seconds": 1830,
"url": "<string>",
"attribution_headers": [
"<string>"
],
"full_request": true,
"match_hosts": [
"<string>"
],
"request_headers": [
{
"name": "<string>",
"type": "plaintext",
"is_set": true,
"value": "<string>"
}
]
}
],
"description": "<string>",
"no_proxy": [
"<string>"
],
"rules": [
{
"name": "<string>",
"aws": {
"role_arn": "<string>",
"subject_scope": "<string>",
"session_tags": {}
},
"azure": {
"tenant_id": "<string>",
"client_id": "<string>",
"subject_scope": "<string>",
"resources": [
"https://storage.azure.com"
]
},
"description": "<string>",
"enabled": true,
"env_vars": {},
"gcp": {
"workload_identity_provider": "<string>",
"service_account_email": "<string>",
"subject_scope": "<string>",
"scopes": [
"<string>"
]
},
"headers": [
{
"name": "<string>",
"type": "plaintext",
"is_set": true,
"value": "<string>"
}
],
"match_headers": [
"<string>"
],
"match_hosts": [
"<string>"
],
"match_paths": [
"<string>"
],
"match_port": 32768,
"match_scheme": "https",
"relay_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"rewrite": {
"port": 32768,
"credentials": "strip",
"host": "<string>",
"sandbox": "<string>"
},
"type": "<string>"
}
]
},
"registry_id": "<string>",
"run_config": {
"env_vars": {},
"user": "<string>",
"work_dir": "<string>"
},
"source_sandbox_id": "<string>",
"status": "<string>",
"status_message": "<string>",
"tags": [
"<string>"
],
"updated_at": "<string>"
}
],
"next_cursor": "<string>",
"offset": 123,
"snapshots": [
{
"created_at": "<string>",
"created_by": "<string>",
"description": "<string>",
"docker_image": "<string>",
"fs_capacity_bytes": 123,
"fs_used_bytes": 123,
"id": "<string>",
"image_digest": "<string>",
"included": [
"mounts"
],
"labels": {},
"memory_snapshot_size_bytes": 123,
"mount_config": {
"auth": {
"aws": {
"role_arn": "<string>",
"subject_scope": "<string>"
},
"azure": {
"tenant_id": "<string>",
"client_id": "<string>",
"subject_scope": "<string>"
},
"gcp": {
"workload_identity_provider": "<string>",
"service_account_email": "<string>",
"subject_scope": "<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
},
"encryption": {
"kms_key": "<string>"
},
"read_only": true,
"azure_blob": {
"container": "<string>",
"storage_account": "<string>",
"prefix": "<string>"
},
"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>",
"proxy_config": {
"access_control": {
"allow_list": [
"<string>"
],
"deny_list": [
"<string>"
]
},
"callbacks": [
{
"ttl_seconds": 1830,
"url": "<string>",
"attribution_headers": [
"<string>"
],
"full_request": true,
"match_hosts": [
"<string>"
],
"request_headers": [
{
"name": "<string>",
"type": "plaintext",
"is_set": true,
"value": "<string>"
}
]
}
],
"description": "<string>",
"no_proxy": [
"<string>"
],
"rules": [
{
"name": "<string>",
"aws": {
"role_arn": "<string>",
"subject_scope": "<string>",
"session_tags": {}
},
"azure": {
"tenant_id": "<string>",
"client_id": "<string>",
"subject_scope": "<string>",
"resources": [
"https://storage.azure.com"
]
},
"description": "<string>",
"enabled": true,
"env_vars": {},
"gcp": {
"workload_identity_provider": "<string>",
"service_account_email": "<string>",
"subject_scope": "<string>",
"scopes": [
"<string>"
]
},
"headers": [
{
"name": "<string>",
"type": "plaintext",
"is_set": true,
"value": "<string>"
}
],
"match_headers": [
"<string>"
],
"match_hosts": [
"<string>"
],
"match_paths": [
"<string>"
],
"match_port": 32768,
"match_scheme": "https",
"relay_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"rewrite": {
"port": 32768,
"credentials": "strip",
"host": "<string>",
"sandbox": "<string>"
},
"type": "<string>"
}
]
},
"registry_id": "<string>",
"run_config": {
"env_vars": {},
"user": "<string>",
"work_dir": "<string>"
},
"source_sandbox_id": "<string>",
"status": "<string>",
"status_message": "<string>",
"tags": [
"<string>"
],
"updated_at": "<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>"
}
}{
"detail": {
"error": "<string>",
"error_id": "<string>",
"message": "<string>"
}
}List snapshots
List workspace and published system snapshots, 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
/
snapshots
Error
A valid request URL is required to generate request examples{
"items": [
{
"created_at": "<string>",
"created_by": "<string>",
"description": "<string>",
"docker_image": "<string>",
"fs_capacity_bytes": 123,
"fs_used_bytes": 123,
"id": "<string>",
"image_digest": "<string>",
"included": [
"mounts"
],
"labels": {},
"memory_snapshot_size_bytes": 123,
"mount_config": {
"auth": {
"aws": {
"role_arn": "<string>",
"subject_scope": "<string>"
},
"azure": {
"tenant_id": "<string>",
"client_id": "<string>",
"subject_scope": "<string>"
},
"gcp": {
"workload_identity_provider": "<string>",
"service_account_email": "<string>",
"subject_scope": "<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
},
"encryption": {
"kms_key": "<string>"
},
"read_only": true,
"azure_blob": {
"container": "<string>",
"storage_account": "<string>",
"prefix": "<string>"
},
"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>",
"proxy_config": {
"access_control": {
"allow_list": [
"<string>"
],
"deny_list": [
"<string>"
]
},
"callbacks": [
{
"ttl_seconds": 1830,
"url": "<string>",
"attribution_headers": [
"<string>"
],
"full_request": true,
"match_hosts": [
"<string>"
],
"request_headers": [
{
"name": "<string>",
"type": "plaintext",
"is_set": true,
"value": "<string>"
}
]
}
],
"description": "<string>",
"no_proxy": [
"<string>"
],
"rules": [
{
"name": "<string>",
"aws": {
"role_arn": "<string>",
"subject_scope": "<string>",
"session_tags": {}
},
"azure": {
"tenant_id": "<string>",
"client_id": "<string>",
"subject_scope": "<string>",
"resources": [
"https://storage.azure.com"
]
},
"description": "<string>",
"enabled": true,
"env_vars": {},
"gcp": {
"workload_identity_provider": "<string>",
"service_account_email": "<string>",
"subject_scope": "<string>",
"scopes": [
"<string>"
]
},
"headers": [
{
"name": "<string>",
"type": "plaintext",
"is_set": true,
"value": "<string>"
}
],
"match_headers": [
"<string>"
],
"match_hosts": [
"<string>"
],
"match_paths": [
"<string>"
],
"match_port": 32768,
"match_scheme": "https",
"relay_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"rewrite": {
"port": 32768,
"credentials": "strip",
"host": "<string>",
"sandbox": "<string>"
},
"type": "<string>"
}
]
},
"registry_id": "<string>",
"run_config": {
"env_vars": {},
"user": "<string>",
"work_dir": "<string>"
},
"source_sandbox_id": "<string>",
"status": "<string>",
"status_message": "<string>",
"tags": [
"<string>"
],
"updated_at": "<string>"
}
],
"next_cursor": "<string>",
"offset": 123,
"snapshots": [
{
"created_at": "<string>",
"created_by": "<string>",
"description": "<string>",
"docker_image": "<string>",
"fs_capacity_bytes": 123,
"fs_used_bytes": 123,
"id": "<string>",
"image_digest": "<string>",
"included": [
"mounts"
],
"labels": {},
"memory_snapshot_size_bytes": 123,
"mount_config": {
"auth": {
"aws": {
"role_arn": "<string>",
"subject_scope": "<string>"
},
"azure": {
"tenant_id": "<string>",
"client_id": "<string>",
"subject_scope": "<string>"
},
"gcp": {
"workload_identity_provider": "<string>",
"service_account_email": "<string>",
"subject_scope": "<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
},
"encryption": {
"kms_key": "<string>"
},
"read_only": true,
"azure_blob": {
"container": "<string>",
"storage_account": "<string>",
"prefix": "<string>"
},
"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>",
"proxy_config": {
"access_control": {
"allow_list": [
"<string>"
],
"deny_list": [
"<string>"
]
},
"callbacks": [
{
"ttl_seconds": 1830,
"url": "<string>",
"attribution_headers": [
"<string>"
],
"full_request": true,
"match_hosts": [
"<string>"
],
"request_headers": [
{
"name": "<string>",
"type": "plaintext",
"is_set": true,
"value": "<string>"
}
]
}
],
"description": "<string>",
"no_proxy": [
"<string>"
],
"rules": [
{
"name": "<string>",
"aws": {
"role_arn": "<string>",
"subject_scope": "<string>",
"session_tags": {}
},
"azure": {
"tenant_id": "<string>",
"client_id": "<string>",
"subject_scope": "<string>",
"resources": [
"https://storage.azure.com"
]
},
"description": "<string>",
"enabled": true,
"env_vars": {},
"gcp": {
"workload_identity_provider": "<string>",
"service_account_email": "<string>",
"subject_scope": "<string>",
"scopes": [
"<string>"
]
},
"headers": [
{
"name": "<string>",
"type": "plaintext",
"is_set": true,
"value": "<string>"
}
],
"match_headers": [
"<string>"
],
"match_hosts": [
"<string>"
],
"match_paths": [
"<string>"
],
"match_port": 32768,
"match_scheme": "https",
"relay_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"rewrite": {
"port": 32768,
"credentials": "strip",
"host": "<string>",
"sandbox": "<string>"
},
"type": "<string>"
}
]
},
"registry_id": "<string>",
"run_config": {
"env_vars": {},
"user": "<string>",
"work_dir": "<string>"
},
"source_sandbox_id": "<string>",
"status": "<string>",
"status_message": "<string>",
"tags": [
"<string>"
],
"updated_at": "<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>"
}
}{
"detail": {
"error": "<string>",
"error_id": "<string>",
"message": "<string>"
}
}Query Parameters
Response
OK
Was this page helpful?

