Delete Sandbox Preview

Deletes a Sandbox Preview by name.

DELETE /sandboxes/{sandboxName}/previews/{previewName}

Delete Sandbox Preview

cURL

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

import requests

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

headers = {"Authorization": "Bearer <token>"}

response = requests.delete(url, headers=headers)

print(response.text)

const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.blaxel.ai/v0/sandboxes/{sandboxName}/previews/{previewName}', 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/{previewName}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	req, _ := http.NewRequest("DELETE", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.delete("https://api.blaxel.ai/v0/sandboxes/{sandboxName}/previews/{previewName}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

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

previewName · string · required

Name of the Preview

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