Skip to main content
ZStack
SLO & Service Quality/Health Check

CheckHealth

Check the overall health status of the service including all dependencies. No authentication required.

GET/health

Operation ID

CheckHealth

Since

1.0.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

This API requires no request parameters.

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • status
    String

    Current health status of the service

    Example: ok

  • service
    String

    Name of the service being checked

    Example: federation