Report process liveness

Overview

Report process liveness. The service-health operation reports whether the HTTP process is alive without requiring authentication or model access.

When to use it

• Use it when an application needs to report process liveness.
• Use it when a load balancer, container orchestrator, or deployment check needs a lightweight liveness signal.

Quick example

Set the base URL and replace generated identifiers or credentials with values from your installation.

curl --request GET \
  --url "$ORDINATE_URL/v1/healthz"

The cURL request supplies the documented path and query values and asks OrdinateDB to report process liveness. The documented 200 response is the literal text `ok`.

How it works

Reference

Required capability

anonymous

Authorization scope

none

Code examples

These examples are generated from the source contract. Replace the base URL, credentials, identifiers, and minimal generated values for your instance.

const ordinateUrl = "http://localhost:8080";
const token = "<bearer-token>";

const response = await fetch(`${ordinateUrl}/v1/healthz`, {
  method: "GET"
});

if (!response.ok) {
  throw new Error(`OrdinateDB returned ${response.status}: ${await response.text()}`);
}

const data = await response.text();
console.log(data);