API-Zugang anfragen
GET

Get health

GET{{API_BASE_URL}}/ticketinghub/health

Reports whether this instance is up and able to serve data. Anonymous — no token required.

Worth calling as a liveness probe at the start of a scheduled extract: it fails fast and clearly, instead of your job discovering the problem halfway through a 400-page walk.

Request

No parameters, no body, no authentication.

Response

  • status (string): Healthy, Degraded or Unhealthy.
  • totalDuration (string): how long the checks took.
  • entries (object): one entry per check.
    • product (object): name and version of the running build.
    • TicketingHub Database Connection (object): whether the data store is reachable.
    • TicketingHub Views (object): whether all four datasets are readable.

What the states mean

StatusMeaningWhat your job should do
HealthyAll checks passedProceed
DegradedReachable, but serving only part of the dataProceed with caution, and alert — a load now may be incomplete
UnhealthyThe data store is unreachable or the datasets cannot be readDo not start; retry later

This reports the API's own health. A 502 or 504 on any request means the gateway could not reach it at all — see Errors.

Include this response when you report a problem to support.

Authentication#auth

This endpoint does not require authentication.

Responses#responses

200OKGet health