List sandboxes

Returns all sandboxes in the workspace. Each sandbox includes its configuration, status, and endpoint URL.

GET /sandboxes

List sandboxes

cURL

curl --request GET \
  --url https://api.blaxel.ai/v0/sandboxes \
  --header 'Authorization: Bearer <token>'

200

[
  {
    "metadata": {
      "name": "my-resource",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "createdBy": "<string>",
      "updatedBy": "<string>",
      "displayName": "My Resource",
      "labels": {},
      "plan": "<string>",
      "url": "<string>",
      "workspace": "<string>"
    },
    "spec": {
      "enabled": true,
      "lifecycle": {
        "expirationPolicies": [
          {
            "action": "delete",
            "type": "ttl-idle",
            "value": "24h"
          }
        ],
        "terminatedRetention": "24h"
      },
      "network": {
        "allowedDomains": "[\"api.stripe.com\", \"api.openai.com\", \"*.s3.amazonaws.com\"]",
        "egress": {
          "gateway": "egress-ip-gw-1",
          "mode": "dedicated",
          "policies": [
            {
              "destinations": "[\"api.stripe.com\"]",
              "mode": "dedicated",
              "name": "payment-apis"
            }
          ]
        },
        "forbiddenDomains": "[\"*.malware.com\", \"evil.example.org\"]",
        "proxy": {
          "bypass": "[\"*.s3.amazonaws.com\"]",
          "routing": [
            {
              "body": "{\"api_key\": \"{{SECRET:stripe-key}}\"}",
              "destinations": "[\"api.stripe.com\"]",
              "headers": "{\"Authorization\": \"Bearer {{SECRET:stripe-key}}\"}",
              "secrets": "{\"stripe-key\": \"sk-live-abc123...\"}"
            }
          ]
        }
      },
      "region": "us-pdx-1",
      "runtime": {
        "envs": [
          {
            "name": "MY_ENV_VAR",
            "secret": true,
            "value": "my-value"
          }
        ],
        "expires": "2025-12-31T23:59:59Z",
        "image": "blaxel/base-image:latest",
        "memory": 4096,
        "ports": [
          {
            "target": 8080,
            "name": "http",
            "protocol": "HTTP"
          }
        ],
        "ttl": "24h"
      },
      "volumes": [
        {
          "mountPath": "/mnt/data",
          "name": "my-volume",
          "readOnly": false
        }
      ]
    },
    "events": [
      {
        "canaryRevision": "<string>",
        "message": "Deployment successful",
        "revision": "rev-abc123",
        "status": "DEPLOYED",
        "time": "2025-01-15T10:30:00Z",
        "type": "deployment"
      }
    ],
    "expiresIn": 123,
    "lastUsedAt": "<string>"
  }
]

Authorizations

OAuth2ApiKeyAuth

Authorization · string · header · required

OAuth2 authentication with JWT tokens

Response

200

application/json

successful operation

metadata · object · required

Common metadata fields shared by all Blaxel resources including name, labels, timestamps, and ownership information

Show child attributes

spec · object · required

Configuration for a sandbox including its image, memory, ports, region, and lifecycle policies

Show child attributes

events · object[] · read-only

Events happening on a resource deployed on Blaxel

Show child attributes

expiresIn · integer · read-only

Time in seconds until the sandbox is automatically deleted based on TTL and lifecycle policies. Only present for sandboxes with lifecycle configured.

lastUsedAt · string · read-only

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

status · enum<string> · read-only

Deployment status of a resource deployed on Blaxel

Available options: DELETING, TERMINATED, FAILED, DEACTIVATED, DEACTIVATING, UPLOADING, BUILDING, DEPLOYING, DEPLOYED, BUILT