Type to search.

Compute an SLO instance summary at a point in time

Base URL
https://{kibana_url}
  • GET /api/observability/slos/{id}/_snapshot
  • GET /s/{space_id}/api/observability/slos/{id}/_snapshot
Auth The Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats. Availability Planned We plan to add this functionality in a future Elastic Stack update. Subject to changes. Unless stated otherwise on the page, this functionality is available when your Elastic Stack is deployed on Elastic Cloud Hosted, Elastic Cloud Enterprise, Elastic Cloud on Kubernetes, and self-managed environments. This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.

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 privileges

Privileges slo_read

Path parameters

space_id string optional

An identifier for the space. If space_id is not provided in the URL, the default space is used. Refer to Spaces for more information.

id string · min length: 8 · max length: 48 · pattern: ^[a-z0-9-_]+$ required

The identifier of the SLO.

Query parameters

at string · max length: 128 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

instanceId union enum | 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.

Values: *

Request body

Any of:

Responses

Successful response

application/json
at string · format: date-time required

The point in time at which the summaries were computed

results union anyOf[] required

The per-instance computation results

Any of:
id string required

The SLO definition id

instanceId string required

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

summary object required

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

errorBudget object required
consumed number required nullable

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 required nullable

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

good number required

The number of good events

sliValue number required nullable

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

status enum required
Values: NO_DATA HEALTHY DEGRADING VIOLATED
total number required

The total number of events