Create Sandbox Preview

Create a preview

POST /sandboxes/{sandboxName}/previews

Create Sandbox Preview

cURL

curl --request POST \
  --url https://api.blaxel.ai/v0/sandboxes/{sandboxName}/previews \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "metadata": {
    "name": "<string>",
    "displayName": "<string>",
    "resourceName": "<string>",
    "resourceType": "<string>",
    "workspace": "<string>"
  },
  "spec": {
    "customDomain": "<string>",
    "expires": "<string>",
    "port": 123,
    "prefixUrl": "<string>",
    "public": true,
    "requestHeaders": {},
    "responseHeaders": {},
    "ttl": "<string>"
  }
}
'

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

Body

application/json

Preview of a Resource

metadata · object · required

PreviewMetadata

Show child attributes

spec · object · required

Preview of a Resource

Show child attributes

Response

200 - application/json

successful operation

Preview of a Resource

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