Skip to main content
API Explorer|API Explorer
Platform Operations/Platform Health
GETPlatformSince 1.0SynchronousAuth Required

GetAggregateHealth

Get the current aggregate health status across all monitored components.

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Request Inputs

This API requires no request parameters.

Responses

200 OK

On success, this API returns the following response structure.

  • overallStatusString

    Overall system health status (healthy, degraded, unhealthy)

    Example: healthy

  • componentsList

    Individual component health statuses

    Example: (nested array)

    • componentString

      Name of the component being monitored

      Example: database

    • statusString

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

      Example: healthy

    • latencyMsString

      Measured latency in milliseconds for this component

      Example: 5

    • messageString

      Additional status message or details

      Example: All queries responding normally

    • checkedAtString

      Checked at

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

  • checkedAtString

    Checked at

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

Endpoint

GET/api/v1/health

/api/v1/health

Operation ID

GetAggregateHealth

Permalink

Request Example

curl -X GET '{host}/api/v1/health' -H 'Authorization: Bearer {token}'

Response Example

200
{
  "overallStatus": "healthy",
  "components": [
    {}
  ],
  "checkedAt": "example"
}

Change History

This API has no change history records yet.

View all change history