Create an SLO

Base URL
https://{kibana_url}
Auth

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

Path parameters

spaceId string required

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

Example: default

Header parameters

kbn-xsrf string required

Cross-site request forgery protection

Request body

artifacts object

Links to related assets for the SLO

dashboards object[]

Array of dashboard references

id string required

Dashboard saved-object id

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 48 chars

indicator union oneOf required
One of:

Defines properties for a custom query indicator type

params object required

An object containing the indicator parameters.

dataViewId string

The kibana data view id to use, primarily used to include data view runtime mappings. Make sure to save SLO again if you add/update run time fields to the data view and if those fields are being used in slo queries.

filter union oneOf

Defines properties for a filter

One of:

the KQL query to filter the documents with.

good union oneOf required

The KQL query used to define the good events.

Same options as filter in params
index string required

The index or index pattern to use

timestampField string required

The timestamp field used in the source indice.

total union oneOf required

The KQL query used to define all events.

Same options as filter in params
type string required

The type of indicator.

name string required

A name for the SLO.

objective object required

Defines properties for the SLO objective

target number · > 0 · < 100 required

the target objective between 0 and 1 excluded

timesliceTarget number · min: 0 · max: 100

the target objective for each slice when using a timeslices budgeting method

timesliceWindow string

the duration of each slice when using a timeslices budgeting method, as {duraton}{unit}

settings object

Defines properties for SLO settings.

frequency string · default: 1m

The interval between checks for changes in the source data. The minimum value is 1m and the maximum is 59m. The default value is 1 minute.

preventCrossProjectSearch boolean · default: false deprecated

Pin the L1 rollup transform to the local/origin project only, preventing flat-world (cross-linked-project) reads. Only applies on serverless. Default is false, meaning rollup transforms target all linked projects.

preventInitialBackfill boolean · default: false

Start aggregating data from the time the SLO is created, instead of backfilling data from the beginning of the time window.

projectRoutings string · max length: 8192 nullable

ES ProjectRouting expression controlling which linked projects the L1 rollup reads. When set (including null), overrides preventCrossProjectSearch. null and _alias:_origin mean origin only; _alias:* means all linked projects. Subset example _id:p1 AND _id:p2.

syncDelay string · default: 1m

The time delay in minutes between the current time and the latest source data time. Increasing the value will delay any alerting. The default value is 1 minute. The minimum value is 1m and the maximum is 359m. It should always be greater then source index refresh interval.

syncField string

The date field that is used to identify new documents in the source. It is strongly recommended to use a field that contains the ingest timestamp. If you use a different field, you might need to set the delay such that it accounts for data transmission delays. When unspecified, we use the indicator timestamp field.

tags string[]

List of tags

timeWindow object required

Defines properties for the SLO time window

duration string required

the duration formatted as {duration}{unit}. Accepted values for rolling: 7d, 30d, 90d. Accepted values for calendar aligned: 1w (weekly) or 1M (monthly)

type enum required

Indicates weither the time window is a rolling or a calendar aligned time window.

Values: rolling calendarAligned

Responses

Successful request

application/json
id string required

Bad request

application/json
error string required
message string required
statusCode number required

Unauthorized response

application/json
error string required
message string required
statusCode number required

Forbidden response

application/json
error string required
message string required
statusCode number required

Conflict - The SLO id already exists

application/json
error string required
message string required
statusCode number required
Base URL
https://{kibana_url}