slo

Get a paginated list of SLOs

Changed on

You must have the read privileges for the SLOs feature in the Observability section of the Kibana feature privileges.

get/s/{spaceId}/api/observability/slos

Request

  • Base URL
    https://localhost:5601
  • URL
    https://localhost:5601/s/{spaceId}/api/observability/slos
  • Auth
    • API key in header Authorization
    • or HTTP basic

Path parameters

spaceIdstring required
Example:default

An identifier for the space. If /s/ and the identifier are omitted from the path, the default space is used.

Query parameters

kqlQuerystring

A valid kql query to filter the SLO with

sizeinteger

The page size to use for cursor-based pagination, must be greater or equal than 1

searchAfterstring[]

The cursor to use for fetching the results from, when using a cursor-base pagination.

pageinteger

The page to use for pagination, must be greater or equal than 1

perPageinteger

Number of SLOs returned by page

sortBy'sli_value' | 'status' | 'error_budget_consumed' | 'error_budget_remaining'

Sort by field

sortDirection'asc' | 'desc'

Sort order

hideStaleboolean

Hide stale SLOs from the list as defined by stale SLO threshold in SLO settings

Headers

kbn-xsrfstring required

Cross-site request forgery protection

Response

Successful request

pagenumber
perPagenumber
searchAfterstring
sizenumber

Size provided for cursor based pagination

totalnumber

Example response

{
  "page": 1,
  "perPage": 25,
  "results": [
    {
      "budgetingMethod": "occurrences",
      "createdAt": "2023-01-12T10:03:19.000Z",
      "description": "My SLO description",
      "enabled": true,
      "id": "8853df00-ae2e-11ed-90af-09bb6422b258",
      "indicator": {
        "params": {
          "dataViewId": "03b80ab3-003d-498b-881c-3beedbaf1162",
          "filter": "field.environment : \"production\" and service.name : \"my-service\"",
          "good": "request.latency <= 150 and request.status_code : \"2xx\"",
          "index": "my-service-*",
          "timestampField": "timestamp",
          "total": "field.environment : \"production\" and service.name : \"my-service\""
        },
        "type": "sli.kql.custom"
      },
      "instanceId": "host-abcde",
      "name": "My Service SLO",
      "objective": {
        "target": 0.99,
        "timesliceTarget": 0.995,
        "timesliceWindow": "5m"
      },
      "revision": 2,
      "settings": {
        "frequency": "5m",
        "preventCrossProjectSearch": true,
        "preventInitialBackfill": true,
        "projectRoutings": "_alias:_origin",
        "syncDelay": "5m",
        "syncField": "event.ingested"
      },
      "summary": {
        "errorBudget": {
          "consumed": 0.8,
          "initial": 0.02,
          "isEstimated": true,
          "remaining": 0.2
        },
        "sliValue": 0.9836,
        "status": "HEALTHY"
      },
      "timeWindow": {
        "duration": "30d",
        "type": "rolling"
      },
      "updatedAt": "2023-01-12T10:03:19.000Z",
      "version": 2
    }
  ],
  "size": 25,
  "total": 34
}

Changes

  • b52bed8a6bceRevision changes
    • info

      added the optional property /// to the response with the status

    • info

      response property results/items/settings/preventCrossProjectSearch deprecated

  • de0bc7723823Revision changes
    • info

      added the optional property /// to the response with the status