Create sandbox

Creates a new sandbox VM for secure AI code execution. Sandboxes automatically scale to zero when idle and resume instantly, preserving memory state including running processes and filesystem.

POST /sandboxes

Create sandbox

cURL

curl --request POST \
  --url https://api.blaxel.ai/v0/sandboxes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "metadata": {
    "name": "my-resource",
    "displayName": "My Resource",
    "labels": {}
  },
  "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
      }
    ]
  }
}
'

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",
      "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>"
}

Authorizations

OAuth2ApiKeyAuth

Authorization · string · header · required

OAuth2 authentication with JWT tokens

Query Parameters

createIfNotExist · boolean · default: false

If true, return existing sandbox instead of 409 error when sandbox exists and is not in FAILED/TERMINATED/TERMINATING state

Body

application/json

Lightweight virtual machine for secure AI code execution. Sandboxes resume from standby in under 25ms and automatically scale to zero after inactivity, preserving memory state including running processes and filesystem.

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

Response

200

application/json

successful operation

Lightweight virtual machine for secure AI code execution. Sandboxes resume from standby in under 25ms and automatically scale to zero after inactivity, preserving memory state including running processes and filesystem.

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)

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