Get the SLO definitions
- Base URL
-
https://{kibana_url}
- GET /s/{spaceId}/internal/observability/slos/_definitions
You must have the read privileges for the SLOs feature in the Observability section of the Kibana feature privileges.
Authentication
Authorization: <value>You must create an API key and use the encoded value in the request header. To learn about creating keys, go to API keys.
Responses
Successful request
-
resultsobject[] -
budgetingMethodenumrequired -
The budgeting method to use when computing the rollup data.
-
Values:
occurrencestimeslices -
groupByunion oneOfrequired -
optional group by field or fields to use to generate an SLO per distinct value
-
One of:
string[]orstring -
indicatorunion oneOfrequired -
One of:
(determined by
type) -
paramsobjectrequired -
An object containing the indicator parameters.
-
dataViewIdstring -
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.
-
filterunion oneOf -
Defines properties for a filter
- One of:
-
goodunion oneOfrequired -
The KQL query used to define the good events.
-
Same options as
filterinparams -
totalunion oneOfrequired -
The KQL query used to define all events.
-
Same options as
filterinparams -
paramsobjectrequired -
An object containing the indicator parameters.
-
paramsobjectrequired -
An object containing the indicator parameters.
-
paramsobjectrequired -
An object containing the indicator parameters.
-
dataViewIdstring -
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.
-
metricobjectrequired -
An object defining the metrics, equation, and threshold to determine if it's a good slice or not
-
settingsobjectrequired -
Defines properties for SLO settings.
-
frequencystring · 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.
-
preventCrossProjectSearchboolean · default: falsedeprecated -
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.
-
preventInitialBackfillboolean · default: false -
Start aggregating data from the time the SLO is created, instead of backfilling data from the beginning of the time window.
-
projectRoutingsstring · max length: 8192nullable -
ES ProjectRouting expression controlling which linked projects the L1 rollup reads. When set (including null), overrides preventCrossProjectSearch. null and
_alias:_originmean origin only;_alias:*means all linked projects. Subset example_id:p1 AND _id:p2. -
syncDelaystring · 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.
-
syncFieldstring -
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.
type: sli.kql.custom
Defines properties for a custom query indicator type
string
the KQL query to filter the documents with.
type: sli.apm.transactionErrorRate
Defines properties for the APM availability indicator type
type: sli.apm.transactionDuration
Defines properties for the APM latency indicator type
type: sli.metric.custom
Defines properties for a custom metric indicator type
type: sli.histogram.custom
Defines properties for a histogram indicator type
type: sli.metric.timeslice
Defines properties for a timeslice metric indicator type
-
resultsobject[] -
Same fields as
resultsinobject
Bad request
Unauthorized response