Skip to main content
GET
/
sandboxes
List sandboxes
curl --request GET \
  --url https://api.blaxel.ai/v0/sandboxes \
  --header 'Authorization: Bearer <token>'
[
  {
    "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",
        "extraArgs": {},
        "image": "blaxel/base-image:latest",
        "memory": 4096,
        "ports": [
          {
            "target": 8080,
            "name": "http",
            "protocol": "HTTP"
          }
        ],
        "terminationGracePeriodSeconds": 30,
        "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>",
    "state": "RUNNING",
    "status": "DELETING"
  }
]

Documentation Index

Fetch the complete documentation index at: https://docs.blaxel.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

OAuth2 authentication with JWT tokens

Query Parameters

showTerminated
boolean
default:false

If true, include terminated sandboxes in the response. Defaults to false.

Response

successful operation

metadata
object
required

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

spec
object
required

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

events
object[]
read-only

Events happening on a resource deployed on Blaxel

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)

state
enum<string>
read-only

Current state of the sandbox (read-only, managed by the system)

Available options:
RUNNING,
STANDBY
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
Last modified on May 13, 2026