List Sandboxes

Returns a list of Sandbox Previews in the workspace.

GET /sandboxes/{sandboxName}/previews

List Sandboxes

cURL

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

200

[
  {
    "metadata": {
      "name": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "createdBy": "<string>",
      "updatedBy": "<string>",
      "displayName": "<string>",
      "resourceName": "<string>",
      "resourceType": "<string>",
      "workspace": "<string>"
    },
    "spec": {
      "customDomain": "<string>",
      "expires": "<string>",
      "port": 123,
      "prefixUrl": "<string>",
      "public": true,
      "region": "<string>",
      "requestHeaders": {},
      "responseHeaders": {},
      "ttl": "<string>",
      "url": "<string>"
    },
    "events": [
      {
        "canaryRevision": "<string>",
        "message": "Deployment successful",
        "revision": "rev-abc123",
        "status": "DEPLOYED",
        "time": "2025-01-15T10:30:00Z",
        "type": "deployment"
      }
    ]
  }
]

Authorizations

OAuth2ApiKeyAuth

Authorization · string · header · required

OAuth2 authentication with JWT tokens

Path Parameters

sandboxName · string · required

Name of the Sandbox

Response

200 - application/json

successful operation

metadata · object · required

PreviewMetadata

Show child attributes

spec · object · required

Preview of a Resource

Show child attributes

events · object[] · read-only

Events happening on a resource deployed on Blaxel

Show child attributes

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