Skip to content
SimicX

Meta · Endpoint

Health

Service health and availability — the public liveness probe.

GET/v1/health

Public — no key at all. The only route that takes no credential, and the only one never metered against a key.

Example request

curl

curl "https://api.simicx.com/v1/health"

Try it

Execute GET /v1/health against the live API — no API key or account required. This route is public and is never metered against a key.

Sent server-side via a same-origin proxy; only the documented host(s) are allowed.

Request

GEThttps://api.simicx.com/v1/health

Example response

JSON · synthetic values, real schema

{
  "status": "ok",
  "service": "simicx-public-api",
  "environment": "production",
  "version": "1.0.0",
  "registry_version": "2.1.0",
  "time": "2026-07-28T14:03:11Z"
}

Response fields

Every field the response can carry, what it means, and how it is computed.

  • statusok | degraded

    Whether the service is fully available.

    How it is computed

    ok when the results store answers a ping; degraded when that dependency is unreachable. HTTP status stays 200 either way so probes can distinguish process liveness from full availability.

  • servicestring

    Service name.

    How it is computed

    The deployed service's configured name.

  • environmentstring

    Deployment environment.

    How it is computed

    e.g. production.

  • versionstring

    Build version of the service.

    How it is computed

    The running app's version string.

  • registry_versionstring

    Version of the endpoint registry in force.

    How it is computed

    Bumped when endpoints or groups change; matches registry_version on /v1/me.

  • timeISO timestamp

    Server clock at response time (UTC).

    How it is computed

    Use it to check clock skew before relying on Retry-After arithmetic.