Skip to main content
POST
/
sandboxes
/
{sandboxName}
/
previews
Create Sandbox Preview
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>"
  }
}
'
import requests

url = "https://api.blaxel.ai/v0/sandboxes/{sandboxName}/previews"

payload = {
    "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>"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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>'
    }
  })
};

fetch('https://api.blaxel.ai/v0/sandboxes/{sandboxName}/previews', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.blaxel.ai/v0/sandboxes/{sandboxName}/previews",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.blaxel.ai/v0/sandboxes/{sandboxName}/previews"

	payload := strings.NewReader("{\n  \"metadata\": {\n    \"name\": \"<string>\",\n    \"displayName\": \"<string>\",\n    \"resourceName\": \"<string>\",\n    \"resourceType\": \"<string>\",\n    \"workspace\": \"<string>\"\n  },\n  \"spec\": {\n    \"customDomain\": \"<string>\",\n    \"expires\": \"<string>\",\n    \"port\": 123,\n    \"prefixUrl\": \"<string>\",\n    \"public\": true,\n    \"requestHeaders\": {},\n    \"responseHeaders\": {},\n    \"ttl\": \"<string>\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.blaxel.ai/v0/sandboxes/{sandboxName}/previews")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"metadata\": {\n    \"name\": \"<string>\",\n    \"displayName\": \"<string>\",\n    \"resourceName\": \"<string>\",\n    \"resourceType\": \"<string>\",\n    \"workspace\": \"<string>\"\n  },\n  \"spec\": {\n    \"customDomain\": \"<string>\",\n    \"expires\": \"<string>\",\n    \"port\": 123,\n    \"prefixUrl\": \"<string>\",\n    \"public\": true,\n    \"requestHeaders\": {},\n    \"responseHeaders\": {},\n    \"ttl\": \"<string>\"\n  }\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.blaxel.ai/v0/sandboxes/{sandboxName}/previews")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"metadata\": {\n    \"name\": \"<string>\",\n    \"displayName\": \"<string>\",\n    \"resourceName\": \"<string>\",\n    \"resourceType\": \"<string>\",\n    \"workspace\": \"<string>\"\n  },\n  \"spec\": {\n    \"customDomain\": \"<string>\",\n    \"expires\": \"<string>\",\n    \"port\": 123,\n    \"prefixUrl\": \"<string>\",\n    \"public\": true,\n    \"requestHeaders\": {},\n    \"responseHeaders\": {},\n    \"ttl\": \"<string>\"\n  }\n}"

response = http.request(request)
puts response.read_body
{
  "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

​
Authorization
string
header
required

OAuth2 authentication with JWT tokens

Path Parameters

​
sandboxName
string
required

Name of the Sandbox

Query Parameters

​
force
boolean

Force creation by replacing conflicting previews that use the same custom domain prefix URL

Body

application/json

Preview of a Resource

​
metadata
object
required

PreviewMetadata

​
spec
object
required

Preview of a Resource

Response

200 - application/json

successful operation

Preview of a Resource

​
metadata
object
required

PreviewMetadata

​
spec
object
required

Preview of a Resource

​
events
object[]
read-only

Events happening on a resource deployed on Blaxel

​
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 July 1, 2026