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

GetSLA

Get the monthly SLA report including uptime percentage and incident breakdown.

Execution Availability

Try It Out

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

Query Parameters

Request Inputs

Query Parameters

  • monthString

    Month to retrieve SLA data for in YYYY-MM format Month to retrieve SLA data for in YYYY-MM format

Responses

200 OK

On success, this API returns the following response structure.

  • monthString

    Month of the SLA report in YYYY-MM format

    Example: 2025-01

  • totalMinutesString

    Total number of minutes in the reporting period

    Example: 43800

  • healthyMinutesString

    Number of minutes the system was healthy

    Example: 43778

  • uptimePctLong

    Overall uptime percentage (0.0 to 100.0)

    Example: 99.95

  • componentBreakdownList

    Per-component SLA breakdown

    Example: (nested array)

    • componentString

      Name of the component

      Example: database

    • uptimePctLong

      Uptime percentage for the reporting period (0.0 to 100.0)

      Example: 99.95

    • incidentCountInteger

      Number of incidents in the reporting period

      Example: 1

Endpoint

GET/api/v1/health/sla

/api/v1/health/sla

Operation ID

GetSLA

Permalink

Request Example

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

Response Example

200
{
  "month": "2025-01",
  "totalMinutes": 43800,
  "healthyMinutes": 43778,
  "uptimePct": 99.95,
  "componentBreakdown": [
    {}
  ]
}

Change History

This API has no change history records yet.

View all change history