Upgrade the sandbox-api

Triggers an upgrade of the sandbox-api process. Returns 200 immediately before upgrading. The upgrade will: download the specified binary from GitHub releases, validate it, and restart. All running processes will be preserved across the upgrade. Available versions: “latest” (default, most recent release), “develop”, “main”, or specific tag like “v1.0.0” You can also specify a custom baseUrl for forks (defaults to https://github.com/blaxel-ai/sandbox/releases)

POST /upgrade

Upgrade the sandbox-api

cURL

curl --request POST \
  --url https://sbx-{sandbox_id}-{workspace_id}.{region}.bl.run/upgrade \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "baseUrl": "https://github.com/blaxel-ai/sandbox/releases",
  "version": "latest"
}
'

import requests

url = "https://sbx-{sandbox_id}-{workspace_id}.{region}.bl.run/upgrade"

payload = {
    "baseUrl": "https://github.com/blaxel-ai/sandbox/releases",
    "version": "latest"
}
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({baseUrl: 'https://github.com/blaxel-ai/sandbox/releases', version: 'latest'})
};

fetch('https://sbx-{sandbox_id}-{workspace_id}.{region}.bl.run/upgrade', 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://sbx-{sandbox_id}-{workspace_id}.{region}.bl.run/upgrade",
  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([
    'baseUrl' => 'https://github.com/blaxel-ai/sandbox/releases',
    'version' => 'latest'
  ]),
  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://sbx-{sandbox_id}-{workspace_id}.{region}.bl.run/upgrade"

	payload := strings.NewReader("{\n  \"baseUrl\": \"https://github.com/blaxel-ai/sandbox/releases\",\n  \"version\": \"latest\"\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://sbx-{sandbox_id}-{workspace_id}.{region}.bl.run/upgrade")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"baseUrl\": \"https://github.com/blaxel-ai/sandbox/releases\",\n  \"version\": \"latest\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sbx-{sandbox_id}-{workspace_id}.{region}.bl.run/upgrade")

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  \"baseUrl\": \"https://github.com/blaxel-ai/sandbox/releases\",\n  \"version\": \"latest\"\n}"

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

200

{
  "message": "File created successfully",
  "path": "/path/to/file"
}

{
  "error": "Error message"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Upgrade options

baseUrl · string

Base URL for releases (useful for forks)

Example:

"https://github.com/blaxel-ai/sandbox/releases"

version · string

Version to upgrade to: "latest" (default), "develop", "main", or specific tag like "v1.0.0"

Example:

"latest"

Response

200

application/json

Upgrade initiated

message · string · required

Example:

"File created successfully"

path · string

Example:

"/path/to/file"