system

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

Request

Base URL
https://api.blaxel.ai/v0
Auth
- OAuth 2
  Authorization code/oauth/authorize
  Client credentials
  Token URL/oauth/token
  Scopesadmin
- or HTTP bearer
TypeScript
https://skmtc.dev/blaxel/apis/blaxel-control-plane/docs/upgrade/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

baseUrlstring

Base URL for releases (useful for forks)

versionstring

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

Example request

{
  "baseUrl": "https://github.com/blaxel-ai/sandbox/releases",
  "version": "latest"
}

Response

Upgrade initiated

messagestring required

pathstring

Example response

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

Changes

No recorded changes to this operation across all 1 revision of this API.