System

Health

Changed on

Liveness probe for the combined control-plane app.

Unauthenticated and dependency-free so orchestrators and load balancers have a stable target. Returns {"status": "ok"} when the process is up.

get/health

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /health
  • Auth: none required

Response

Successful Response

reasonstring nullable

Why the deployment is not entitled. Present only on the not_entitled body.

statusstring required

ok while the process is serving requests. A metered marketplace deployment whose entitlement lapsed answers not_entitled (still HTTP 200, so orchestrators don't restart it).

versionstring nullable

Running Jentic One release. Absent on the not_entitled body.

Example response

{
  "status": "ok",
  "version": "1.0.0"
}

Changes

  • a60e7cd27ce9Revision changes
    • breaking

      the response's body type changed from no type to object for status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

  • d65fcba0d25aRevision changes
    • info

      api operation id health_health_get removed and replaced with getHealth

    • info

      api tag System added

    • info

      api tag meta removed

    • info

      removed from the response body anyOf list for the response status