Health check

Reports runtime mode, queue statistics, and migration status.

GET /health

Get service health

cURL

curl --request GET \
  --url http://127.0.0.1:4000/health

import requests

url = "http://127.0.0.1:4000/health"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('http://127.0.0.1:4000/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_PORT => "4000",
  CURLOPT_URL => "http://127.0.0.1:4000/health",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$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 := "http://127.0.0.1:4000/health"

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

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("http://127.0.0.1:4000/health")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://127.0.0.1:4000/health")

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

request = Net::HTTP::Get.new(url)

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

200

{
  "queueDriver": "memory",
  "queue": {
    "agentRunConcurrency": 123,
    "toolExecuteConcurrency": 123,
    "totalJobs": 123,
    "queuedJobs": 123,
    "runningJobs": 123,
    "completedJobs": 123,
    "failedJobs": 123,
    "byType": {
      "agentRun": {
        "queued": 123,
        "running": 123,
        "completed": 123,
        "failed": 123
      },
      "toolExecute": {
        "queued": 123,
        "running": 123,
        "completed": 123,
        "failed": 123
      }
    }
  },
  "migration": {
    "status": "<string>",
    "pendingCount": 123,
    "appliedCount": 123,
    "errorMessage": "<string>"
  }
}

Response

200 - application/json

Service health snapshot

status · enum<string> · required

Available options: ok, degraded

mode · enum<string> · required

Available options: normal, read_only

queueDriver · enum<string> · required

Available options: memory

queue · object · required

Show child attributes

migration · object | null · required

Show child attributes