Skip to main content
ZStack
Platform Operations/Platform Health

GetAggregateHealth

Get the current aggregate health status across all monitored components.

GET/api/v1/health

Operation ID

GetAggregateHealth

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.

  • overallStatus
    String

    Overall system health status (healthy, degraded, unhealthy)

    Example: healthy

  • components
    List

    Individual component health statuses

    Example: (nested array)

    • component
      String

      Name of the component being monitored

      Example: database

    • status
      String

      Health status of this component (healthy, degraded, unhealthy)

      Example: healthy

    • latencyMs
      String

      Measured latency in milliseconds for this component

      Example: 5

    • message
      String

      Additional status message or details

      Example: All queries responding normally

    • checkedAt
      String

      Checked at

      Example: 2026-01-15T08:00:00Z

  • checkedAt
    String

    Checked at

    Example: 2026-01-15T08:00:00Z