ELelastic
slo

Get the SLO definitions

Changed on

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

get/s/{spaceId}/internal/observability/slos/_definitions

Request

  • Base URL
    https://localhost:5601
  • URL
    https://localhost:5601/s/{spaceId}/internal/observability/slos/_definitions
  • 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

includeOutdatedOnlyboolean

Indicates if the API returns only outdated SLO or all SLO definitions

includeHealthboolean

Indicates if the API returns SLO health data with definitions

tagsstring

Filters the SLOs by tag

searchstring

Filters the SLOs by name

pagenumber

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

perPageinteger

Number of SLOs returned by page

Headers

kbn-xsrfstring required

Cross-site request forgery protection

Response

Successful request

OR

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
    }
  ],
  "total": 34
}

Changes

  • b52bed8a6bceRevision changes
    • breaking

      added subschema #1 subschema #2 to the response body oneOf list for the response status

    • info

      removed subschema #1 subschema #2 from the response body oneOf list for the response status

  • de0bc7723823Revision changes
    • breaking

      added subschema #1 subschema #2 to the response body oneOf list for the response status

    • info

      removed subschema #1 subschema #2 from the response body oneOf list for the response status