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

GetHealthIncidents

List recent health incidents with duration and affected component details.

Execution Availability

Try It Out

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

Query Parameters

Request Inputs

Query Parameters

  • limitInteger

    Maximum number of incidents to return Maximum number of incidents to return

    Example: 0

Responses

200 OK

On success, this API returns the following response structure.

  • itemsList

    List of health incidents ordered by started_at descending

    Example: (nested array)

    • idString

      Unique identifier of the health incident

      Example: incident-001

    • startedAtString

      Started at

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

    • recoveredAtString

      Recovered at

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

    • durationSecString

      Total duration of the incident in seconds

      Example: 300

    • affectedStatusString

      The health status that was affected during the incident

      Example: unhealthy

    • componentsList

      List of component names affected by this incident

      Example: item1,item2

Endpoint

GET/api/v1/health/incidents

/api/v1/health/incidents

Operation ID

GetHealthIncidents

Permalink

Request Example

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

Response Example

200
{
  "items": [
    {}
  ]
}

Change History

This API has no change history records yet.

View all change history