Error
A valid request URL is required to generate request examples{
"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>"
}
]
},
"run_config": {
"env_vars": {},
"user": "<string>",
"work_dir": "<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>"
}
}Get a sandbox
Retrieve a sandbox by name. Stale provisioning sandboxes are auto-failed.
GET
/
api
/
v2
/
sandboxes
/
boxes
/
{name}
Error
A valid request URL is required to generate request examples{
"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>"
}
]
},
"run_config": {
"env_vars": {},
"user": "<string>",
"work_dir": "<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>"
}
}Authorizations
API KeyTenant IDBearer Auth
Path Parameters
Sandbox display name
Response
OK
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
RunConfig is what the sandbox's commands run with: the user, working directory and base env beneath env_vars.
Show child attributes
Show child attributes
Was this page helpful?

