Service health

Check control API health. Inspect the catalog separately for actual execution readiness.

View as Markdown ↗

GET/healthz

Check the API is responding

Call this endpoint without a token to check the control API.

What to do next

For actual tool availability, make an authenticated request to the tool catalog.

Read the step-by-step guide →

Parameter and response reference

Responses

200 Successful Response

Copyable examples · your API endpoint

Request

curl -X GET "$SECURITY_RUN_URL/healthz"

Request

import os, httpx

headers = {}
response = httpx.request('GET', os.environ["SECURITY_RUN_URL"].rstrip("/") + '/healthz',
    headers=headers)
response.raise_for_status()
print(response.text)

Request

const base = process.env.SECURITY_RUN_URL.replace(/\/$/, "");
const headers = {};
const response = await fetch(base + "/healthz", {
  method: "GET",
  headers
});
if (!response.ok) throw new Error(`HTTP ${response.status}`);
console.log(await response.text());