Skip to main content
GET
/
sandboxes
/
{sandboxName}
Get Sandbox
curl --request GET \
  --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": "<any>",
    "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,
      "traffic": 123
    },
    "runtime": {
      "args": [
        "<any>"
      ],
      "command": [
        "<any>"
      ],
      "configuration": {},
      "cpu": 123,
      "endpointName": "<string>",
      "envs": [
        "<any>"
      ],
      "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
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
sandboxName
string
required

Name of the Sandbox

Query Parameters

​
show_secrets
boolean

Show secret values (admin only)

Response

200 - application/json

successful operation

Micro VM for running agentic tasks

​
events
object[]

Core events

​
lastUsedAt
string

Last time the sandbox was used (read-only, managed by the system)

​
metadata
object

Metadata Time fields for Persistance Owner fields for Persistance

​
spec
object

Sandbox specification Core specification

​
status
string

Sandbox status

​
ttl
integer

TTL timestamp for automatic deletion (optional, nil means no auto-deletion)