Health check

Returns health status and system information including upgrade count and binary details Also includes last upgrade attempt status with detailed error information if available

GET /health

Health check

cURL

curl --request GET \
  --url https://sbx-{sandbox_id}-{workspace_id}.{region}.bl.run/health \
  --header 'Authorization: Bearer <token>'

import requests

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

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

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

print(response.text)

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

fetch('https://sbx-{sandbox_id}-{workspace_id}.{region}.bl.run/health', 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/health",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  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://sbx-{sandbox_id}-{workspace_id}.{region}.bl.run/health"

	req, _ := http.NewRequest("GET", 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.get("https://sbx-{sandbox_id}-{workspace_id}.{region}.bl.run/health")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

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

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

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

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

200

{
  "arch": "amd64",
  "buildTime": "2026-01-29T17:36:52.000Z",
  "gitCommit": "abc123",
  "goVersion": "go1.25.0",
  "lastUpgrade": {
    "status": "running",
    "step": "download",
    "version": "latest",
    "binaryPath": "/tmp/sandbox-api-new",
    "bytesDownloaded": 25034936,
    "downloadUrl": "https://github.com/...",
    "error": "Failed to download binary",
    "lastAttempt": "<string>"
  },
  "os": "linux",
  "startedAt": "2026-01-29T18:45:49.000Z",
  "status": "ok",
  "upgradeCount": 0,
  "uptime": "1h30m",
  "uptimeSeconds": 5400.5,
  "version": "v0.1.0"
}

Authorizations

Authorization · string · header · required

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

Response

200 - application/json

Health status

arch · string · required

Example:

"amd64"

buildTime · string · required

Example:

"2026-01-29T17:36:52.000Z"

gitCommit · string · required

Example:

"abc123"

goVersion · string · required

Example:

"go1.25.0"

lastUpgrade · object · required

Show child attributes

os · string · required

Example:

"linux"

startedAt · string · required

Example:

"2026-01-29T18:45:49.000Z"

status · string · required

Example:

"ok"

upgradeCount · integer · required

Example:

0

uptime · string · required

Example:

"1h30m"

uptimeSeconds · number · required

Example:

5400.5

version · string · required

Example:

"v0.1.0"