Skip to main content
API Explorer|API Explorer
Monitoring & Collection/Monitoring Query & Overview
GETMonitoringSince 1.0SynchronousAuth Required

GetSLAReport

Generate a Service Level Agreement (SLA) report for a platform over a given period

Execution Availability

Try It Out

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

Path Parameters

Query Parameters

Request Inputs

Path Parameters

  • platformUuidStringRequired

    UUID of the platform to generate the SLA report for

Query Parameters

  • periodString

    Reporting period identifier (e.g. 2024-01, last-30d) Reporting period identifier (e.g. 2024-01, last-30d)

Responses

200 OK

On success, this API returns the following response structure.

  • platformUuidString

    UUID of the platform this SLA report covers

    Example: plat-001-abc

  • periodString

    Reporting period (e.g. 2024-01, last-30d)

    Example: 2024-01

  • uptimePercentLong

    Percentage of time the platform was operational

    Example: 99.95

  • mttrMinutesString

    Mean Time To Recover in minutes

    Example: 12

  • mtbfMinutesString

    Mean Time Between Failures in minutes

    Example: 14400

  • incidentCountInteger

    Total number of incidents during the period

    Example: 3

  • totalDowntimeMinutesString

    Total platform downtime in minutes during the period

    Example: 21

  • slaTargetLong

    SLA target uptime percentage threshold

    Example: 99.9

  • slaMetBoolean

    Whether the SLA target was met during this period

    Example: true

Endpoint

GET/api/v1/monitoring/platform/{platformUuid}/sla-report

/api/v1/monitoring/platform/{platformUuid}/sla-report

Operation ID

GetSLAReport

Permalink

Request Example

curl -X GET '{host}/api/v1/monitoring/platform/{platformUuid}/sla-report' -H 'Authorization: Bearer {token}'

Response Example

200
{
  "platformUuid": "plat-001-abc",
  "period": "2024-01",
  "uptimePercent": 99.95,
  "mttrMinutes": 12,
  "mtbfMinutes": 14400,
  "incidentCount": 3,
  "totalDowntimeMinutes": 21,
  "slaTarget": 99.9
}

Change History

This API has no change history records yet.

View all change history