Health

Health check

Returns the current health status of the API. Can be used by load balancers, monitoring tools, or deployment pipelines to verify the service is running.

get/healthcheck

Request

  • Base URL
    https://company-eligibles-api.totalpass.com
  • URL
    https://company-eligibles-api.totalpass.com/healthcheck
  • Auth
    none required

Response

Service is healthy

statusstring required

Example response

{
  "status": "ok"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.