Compute an SLO instance summary at a point in time Generally available

GET /api/observability/slos/{id}/_snapshot
Api key auth

Spaces method and path for this operation:

get /s/{space_id}/api/observability/slos/{id}/_snapshot

Refer to Spaces for more information.

Compute the summary of an SLO at a given point in time. When instanceId is provided, returns that instance. When instanceId is omitted or set to '*', returns all matching instances (up to 1000). The endpoint is synchronous and returns results directly. You must have the read privileges for the SLOs feature in the Observability section of the Kibana feature privileges.

[Required authorization] Route required privileges: slo_read.

Path parameters

  • id string Required

    The identifier of the SLO.

    Minimum length is 8, maximum length is 48. Format should match the following pattern: ^[a-z0-9-_]+$.

Query parameters

  • at string Required

    The point in time at which to compute the SLO instance summary (ISO 8601 date-time), for example 2023-01-12T10:03:19.000Z

    Maximum length is 128.

  • instanceId string

    The SLO instance ID. Omit this parameter or set it to '*' to return all instances for the SLO (up to 1000). Set a specific value (for example host.name:web-01) to return that instance only.

    Value is *.

application/json

Body

object | null object | null

Additional properties are NOT allowed.

Responses

  • 200 application/json

    Successful response

    Hide response attributes Show response attributes object
    • at string(date-time) Required

      The point in time at which the summaries were computed

    • results array[object] Required

      The per-instance computation results

      Hide results attributes Show results attributes object

      The result of computing an SLO instance summary at a point in time. Contains either a summary (on success) or an error (on failure).

      • error object

        Error information when the computation failed for this SLO instance. Present when the computation failed.

        Hide error attributes Show error attributes object
        • message string Required

          The error message

        • statusCode number Required

          The HTTP status code of the error

      • id string Required

        The SLO definition id

      • instanceId string Required

        The SLO instance id. '*' represents the default (ungrouped) instance.

      • summary object

        The SLO instance summary at the requested point in time. Present when the computation succeeded.

        Hide summary attributes Show summary attributes object
        • errorBudget object Required
          Hide errorBudget attributes Show errorBudget attributes object
          • consumed number | null Required

            The error budget consumed, or null when no data is available

          • initial number Required

            The initial error budget, derived from the SLO objective

          • remaining number | null Required

            The error budget remaining, or null when no data is available

        • good number Required

          The number of good events

        • sliValue number | null Required

          The SLI value at the requested point in time, or null when no data is available

        • status string Required

          The SLO health status

          Values are NO_DATA, HEALTHY, DEGRADING, or VIOLATED.

        • total number Required

          The total number of events
  • 400 application/json

    Bad request

    Hide response attributes Show response attributes object
    • error string Required
    • message string Required
    • statusCode number Required
  • 401 application/json

    Unauthorized response

    Hide response attributes Show response attributes object
    • error string Required
    • message string Required
    • statusCode number Required
  • 403 application/json

    Forbidden response

    Hide response attributes Show response attributes object
    • error string Required
    • message string Required
    • statusCode number Required
  • 404 application/json

    Not found response

    Hide response attributes Show response attributes object
    • error string Required
    • message string Required
    • statusCode number Required
GET /api/observability/slos/{id}/_snapshot 
curl \
 --request GET 'https://<KIBANA_URL>/api/observability/slos/{id}/_snapshot?at=string' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json"
Response examples (200) 
{
  "at": "2025-01-12T10:00:00.000Z",
  "results": [
    {
      "id": "8853df00-ae2e-11ed-90af-09bb6422b258",
      "instanceId": "*",
      "summary": {
        "errorBudget": {
          "consumed": 0.24,
          "initial": 0.01,
          "remaining": 0.76
        },
        "good": 9976,
        "sliValue": 0.9976,
        "status": "HEALTHY",
        "total": 10000
      }
    }
  ]
}
{
  "at": "2025-01-12T10:00:00.000Z",
  "results": [
    {
      "id": "8853df00-ae2e-11ed-90af-09bb6422b258",
      "instanceId": "host.name:web-01",
      "summary": {
        "errorBudget": {
          "consumed": 5,
          "initial": 0.01,
          "remaining": -4
        },
        "good": 9500,
        "sliValue": 0.95,
        "status": "VIOLATED",
        "total": 10000
      }
    }
  ]
}
Response examples (400) 
{
  "error": "Bad Request",
  "message": "Invalid value 'foo' supplied to: at",
  "statusCode": 400
}
Response examples (401) 
{
  "error": "Unauthorized",
  "message": "security_exception: unable to authenticate user for REST request [/api/observability/slos]",
  "statusCode": 401
}
Response examples (403) 
{
  "error": "Forbidden",
  "message": "security_exception: action [slo_read] is unauthorized for user",
  "statusCode": 403
}
Response examples (404) 
{
  "error": "Not Found",
  "message": "SLO [8853df00-ae2e-11ed-90af-09bb6422b258] not found",
  "statusCode": 404
}