curl --request DELETE \
--url https://api.blaxel.ai/v0/sandboxes/{sandboxName} \
--header 'Authorization: Bearer <token>'{
"events": [
{
"canaryRevision": "<string>",
"message": "<string>",
"revision": "<string>",
"status": "<string>",
"time": "<string>",
"type": "<string>"
}
],
"lastUsedAt": "<string>",
"metadata": {
"createdAt": "<string>",
"updatedAt": "<string>",
"createdBy": "<string>",
"updatedBy": "<string>",
"displayName": "<string>",
"labels": {},
"name": "<string>",
"plan": "<unknown>",
"url": "<string>",
"workspace": "<string>"
},
"spec": {
"configurations": {
"key": {
"secret": true,
"value": "<string>"
}
},
"enabled": true,
"flavors": [
{
"name": "<string>",
"type": "<string>"
}
],
"integrationConnections": [
"<string>"
],
"policies": [
"<string>"
],
"revision": {
"active": "<string>",
"canary": "<string>",
"canaryPercent": 123,
"stickySessionTtl": 123,
"traffic": 123
},
"runtime": {
"args": [
"<unknown>"
],
"command": [
"<unknown>"
],
"configuration": {},
"cpu": 123,
"endpointName": "<string>",
"envs": [
"<unknown>"
],
"expires": "<string>",
"generation": "<string>",
"image": "<string>",
"maxConcurrentTasks": 123,
"maxRetries": 123,
"maxScale": 123,
"memory": 123,
"metricPort": 123,
"minScale": 123,
"model": "<string>",
"organization": "<string>",
"ports": [
{
"name": "<string>",
"protocol": "<string>",
"target": 123
}
],
"startupProbe": {},
"timeout": 123,
"transport": "<string>",
"ttl": "<string>",
"type": "<string>"
},
"sandbox": true,
"lifecycle": {
"expirationPolicies": [
{
"action": "<string>",
"type": "<string>",
"value": "<string>"
}
]
},
"region": "<string>",
"volumes": [
{
"mountPath": "<string>",
"name": "<string>",
"readOnly": true
}
]
},
"status": "<string>",
"ttl": 123
}Deletes a Sandbox by name.
curl --request DELETE \
--url https://api.blaxel.ai/v0/sandboxes/{sandboxName} \
--header 'Authorization: Bearer <token>'{
"events": [
{
"canaryRevision": "<string>",
"message": "<string>",
"revision": "<string>",
"status": "<string>",
"time": "<string>",
"type": "<string>"
}
],
"lastUsedAt": "<string>",
"metadata": {
"createdAt": "<string>",
"updatedAt": "<string>",
"createdBy": "<string>",
"updatedBy": "<string>",
"displayName": "<string>",
"labels": {},
"name": "<string>",
"plan": "<unknown>",
"url": "<string>",
"workspace": "<string>"
},
"spec": {
"configurations": {
"key": {
"secret": true,
"value": "<string>"
}
},
"enabled": true,
"flavors": [
{
"name": "<string>",
"type": "<string>"
}
],
"integrationConnections": [
"<string>"
],
"policies": [
"<string>"
],
"revision": {
"active": "<string>",
"canary": "<string>",
"canaryPercent": 123,
"stickySessionTtl": 123,
"traffic": 123
},
"runtime": {
"args": [
"<unknown>"
],
"command": [
"<unknown>"
],
"configuration": {},
"cpu": 123,
"endpointName": "<string>",
"envs": [
"<unknown>"
],
"expires": "<string>",
"generation": "<string>",
"image": "<string>",
"maxConcurrentTasks": 123,
"maxRetries": 123,
"maxScale": 123,
"memory": 123,
"metricPort": 123,
"minScale": 123,
"model": "<string>",
"organization": "<string>",
"ports": [
{
"name": "<string>",
"protocol": "<string>",
"target": 123
}
],
"startupProbe": {},
"timeout": 123,
"transport": "<string>",
"ttl": "<string>",
"type": "<string>"
},
"sandbox": true,
"lifecycle": {
"expirationPolicies": [
{
"action": "<string>",
"type": "<string>",
"value": "<string>"
}
]
},
"region": "<string>",
"volumes": [
{
"mountPath": "<string>",
"name": "<string>",
"readOnly": true
}
]
},
"status": "<string>",
"ttl": 123
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Name of the Sandbox
successful operation
Micro VM for running agentic tasks
Last time the sandbox was used (read-only, managed by the system)
Metadata Time fields for Persistance Owner fields for Persistance
Show child attributes
The date and time when the resource was created
The date and time when the resource was updated
The user or service account who created the resource
The user or service account who updated the resource
Model display name
Model name
Plan
URL
Workspace name
Sandbox specification Core specification
Show child attributes
Optional configurations for the object
Enable or disable the resource
Deployment integration connection name
Policy name
Revision configuration
Set of configurations for a deployment
Show child attributes
The arguments to pass to the deployment runtime
The command to run the deployment
The configuration for the deployment
The CPU for the deployment in cores, only available for private cluster
Endpoint Name of the model. In case of hf_private_endpoint, it is the endpoint name. In case of hf_public_endpoint, it is not used.
The env variables to set in the deployment. Should be a list of Kubernetes EnvVar types
The expiration date for the deployment in ISO 8601 format - 2024-12-31T23:59:59Z
The generation of the deployment
The Docker image for the deployment
The maximum number of concurrent task for an execution
The maximum number of retries for the deployment
The minimum number of replicas for the deployment. Can be 0 or 1 (in which case the deployment is always running in at least one location).
The memory for the deployment in MB
The port to serve the metrics on
The maximum number of replicas for the deployment.
The slug name of the origin model at HuggingFace.
The organization of the model
The readiness probe. Should be a Kubernetes Probe type
The timeout for the deployment in seconds
The transport for the deployment, used by MCPs: "websocket" or "http-stream"
The TTL for the deployment in seconds - 30m, 24h, 7d
The type of origin for the deployment (hf_private_endpoint, hf_public_endpoint)
Sandbox mode
Lifecycle configuration for the sandbox
Show child attributes
Region where the sandbox should be created (e.g. us-pdx-1, eu-lon-1)
Sandbox status
TTL timestamp for automatic deletion (optional, nil means no auto-deletion)
Was this page helpful?