Create an SLO

Base URL: https://{kibana_url}

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

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

Authentication

Api key

Authorization: <value>

These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: Authorization: ApiKey base64AccessApiKey

Basic

Authorization: Basic <credentials>

Path parameters

Header parameters

Request body

artifacts object: Links to related assets for the SLO
budgetingMethod enum required: The budgeting method to use when computing the rollup data.; Values: occurrences timeslices
description string required: A description for the SLO.
groupBy union oneOf: optional group by field or fields to use to generate an SLO per distinct value; One of: string[] or string
id string: A optional and unique identifier for the SLO. Must be between 8 and 36 chars
indicator union oneOf required: One of:
name string required: A name for the SLO.
objective object required: Defines properties for the SLO objective
settings object: Defines properties for SLO settings.
tags string[]: List of tags
timeWindow object required: Defines properties for the SLO time window

Responses

Successful request

application/json

Bad request

application/json

Unauthorized response

application/json

Forbidden response

application/json

Conflict - The SLO id already exists

application/json

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST kbn:/s/default/api/observability/slos
{
  "budgetingMethod": "occurrences",
  "description": "Availability of my web service measured by successful HTTP responses",
  "indicator": {
    "params": {
      "filter": "field.environment : \u0022production\u0022 and service.name : \u0022my-service\u0022",
      "good": "request.status_code : \u00222xx\u0022",
      "index": "logs-*",
      "timestampField": "@timestamp",
      "total": "request.status_code : *"
    },
    "type": "sli.kql.custom"
  },
  "name": "My Service Availability",
  "objective": {
    "target": 0.99
  },
  "settings": {
    "frequency": "5m",
    "syncDelay": "5m"
  },
  "tags": [
    "production",
    "web-service"
  ],
  "timeWindow": {
    "duration": "30d",
    "type": "rolling"
  }
}

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/s/default/api/observability/slos" \
  -H "kbn-xsrf: true" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "budgetingMethod": "occurrences",
    "description": "Availability of my web service measured by successful HTTP responses",
    "indicator": {
      "params": {
        "filter": "field.environment : \u0022production\u0022 and service.name : \u0022my-service\u0022",
        "good": "request.status_code : \u00222xx\u0022",
        "index": "logs-*",
        "timestampField": "@timestamp",
        "total": "request.status_code : *"
      },
      "type": "sli.kql.custom"
    },
    "name": "My Service Availability",
    "objective": {
      "target": 0.99
    },
    "settings": {
      "frequency": "5m",
      "syncDelay": "5m"
    },
    "tags": [
      "production",
      "web-service"
    ],
    "timeWindow": {
      "duration": "30d",
      "type": "rolling"
    }
  }'

Generated from the API spec

Response

{
  "id": "8853df00-ae2e-11ed-90af-09bb6422b258"
}

{
  "error": "Bad Request",
  "message": "Invalid value \u0027foo\u0027 supplied to: indicator/type",
  "statusCode": 400
}

{
  "error": "Unauthorized",
  "message": "security_exception: unable to authenticate user for REST request [/api/observability/slos]",
  "statusCode": 401
}

{
  "error": "Forbidden",
  "message": "security_exception: action [slo_write] is unauthorized for user",
  "statusCode": 403
}

{
  "error": "Conflict",
  "message": "SLO [d077e940-1515-11ee-9c50-9d096392f520] already exists",
  "statusCode": 409
}

Authentication

Path parameters

Header parameters

Request body { }

Responses

Request body