Sign in

v1

latestOpenAPI 3.0.32026-07-22194221292.5 KB
compute

Get sandbox

Returns detailed information about a sandbox including its configuration, attached volumes, lifecycle policies, and API endpoint URL.

get/sandboxes/{sandboxName}

Query parameters

show_secretsboolean

Show secret values (requires workspace admin role)

Response

successful operation

expiresIninteger

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

lastUsedAtstring

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

nodeGenerationstring

Infrastructure generation this sandbox is deployed on (mk3.0 or mk3.1). Read-only.

state'RUNNING' | 'STANDBY'

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

status'DELETING' | 'TERMINATED' | 'FAILED' | 'DEACTIVATED' | 'DEACTIVATING' | 'UPLOADING' | 'BUILDING' | 'DEPLOYING' | 'DEPLOYED' | 'BUILT'

Deployment status of a resource deployed on Blaxel

Example response

{
  "events": [
    {
      "message": "Deployment successful",
      "revision": "rev-abc123",
      "status": "DEPLOYED",
      "time": "2025-01-15T10:30:00Z",
      "type": "deployment"
    }
  ],
  "metadata": {
    "displayName": "My Resource",
    "externalId": "my-session-123",
    "name": "my-resource"
  },
  "spec": {
    "enabled": true,
    "lifecycle": {
      "expirationPolicies": [
        {
          "action": "delete",
          "type": "ttl-idle",
          "value": "24h"
        }
      ],
      "terminatedRetention": "24h"
    },
    "network": {
      "egress": {
        "gateway": "egress-ip-gw-1",
        "mode": "dedicated",
        "policies": [
          {
            "mode": "dedicated",
            "name": "payment-apis"
          }
        ]
      },
      "subnet": "default"
    },
    "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": [
        {
          "name": "http",
          "protocol": "HTTP",
          "target": 8080
        }
      ],
      "terminationGracePeriodSeconds": 30,
      "ttl": "24h"
    },
    "volumes": [
      {
        "mountPath": "/mnt/data",
        "name": "my-volume"
      }
    ],
    "vpc": "default"
  }
}