Skip to main content

API Health Information

The users can receive information about the health of the argo-web-api service

GET Health information​

note: Health information can be accessed via both the /api/v2 and /api/v3 endpoints. For consistency, the examples provided will utilize /api/v3

A user can get health information about the argo-web-api instance by issuing the following call:

GET /api/v3/health

Request headers​

Accept: application/json

Response​

Headers: Status: 200 OK

Response Body​

Json Response example:

{
  "status": "OK",
  "timestamp": "2025-07-10T12:30:00Z",
  "message": "No flapping items"
}

Additional Information​

The /health endpoint reflects the overall state of the service and is accessible from any tenant. Therefore, a single call from any tenant is sufficient to determine the health of the service.

The possible values of the status field are:

  • "OK" – the service is healthy

  • "CRITICAL" – issues have been detected

The message field contains a more detailed description of the checks performed and provides additional context about the state of the service.