Kibana slo API is one of 60 APIs that Kibana publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include slo. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.
This API exposes
13 operations
across 10 paths,
and defines 41 schemas.
It is described by OpenAPI 3.0.3.
Requests are made against a single base URL, https://{kibana_url}.
13 operations10 paths41 schemas1 DELETE4 GET7 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Specification
OpenAPI 3.0.3
Base URL
https://localhost:5601/api
Authentication
API Key, HTTP Basic
Contact
Kibana Team
Resource Areas
1
Authentication & Security 2
Kibana slo API declares
2 security schemes
for authenticating requests.
An API key is passed in the header as Authorization (apiKeyAuth).
It accepts HTTP basic authentication (basicAuth).
By default, every request must be authenticated.
apiKeyAuth — 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 base64A…
Paths & Operations 13
Across 10 paths, the API surfaces 13 operations — 1 DELETE, 4 GET, 7 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
slo 13
SLO APIs enable you to define, manage and track service-level objectives
GET
/s/{spaceId}/api/observability/slos
Get a paginated list of SLOs
findSlosOp10 params→ 200400401403404
POST
/s/{spaceId}/api/observability/slos
Create an SLO
createSloOp2 paramsbody→ 200400401403409
POST
/s/{spaceId}/api/observability/slos/_bulk_delete
Bulk delete SLO definitions and their associated summary and rollup data.
The contract defines 41 schemas that model the data the API accepts and returns. The most detailed are SLOs_slo_with_summary_response (17 properties), SLOs_slo_definition_response (16 properties), SLOs_filter_meta (12 properties), SLOs_create_slo_request (11 properties). Each schema is shown below with its type and property counts.
SLOs_slo_definition_response
object
16 properties15 required
SLOs_filter
object
Defines properties for a filter
2 properties
SLOs_indicator_properties_timeslice_metric
object
Defines properties for a timeslice metric indicator type
2 properties2 required
SLOs_find_slo_definitions_response
object
A paginated response of SLO definitions matching the query.
SLOs_summary
object
The SLO computed data
3 properties3 required
SLOs_error_budget
object
4 properties4 required
SLOs_update_slo_request
object
The update SLO API request body varies depending on the type of indicator, time window and budgeting method. Partial update is handled.
10 properties
SLOs_artifacts
object
Links to related assets for the SLO
1 property
SLOs_bulk_purge_rollup_response
object
The bulk purge rollup data response returns a task id from the elasticsearch deleteByQuery response.
1 property
SLOs_403_response
object
3 properties3 required
SLOs_indicator_properties_custom_metric
object
Defines properties for a custom metric indicator type
2 properties2 required
SLOs_find_slo_response
object
A paginated response of SLOs matching the query.
6 properties
SLOs_bulk_delete_response
object
The bulk delete SLO response returns a taskId that can be used to poll for its status
1 property
SLOs_kql_with_filters
Defines properties for a filter
SLOs_settings
object
Defines properties for SLO settings.
4 properties
SLOs_create_slo_request
object
The create SLO API request body varies depending on the type of indicator, time window and budgeting method.
11 properties6 required
SLOs_404_response
object
3 properties3 required
SLOs_indicator_properties_custom_kql
object
Defines properties for a custom query indicator type
2 properties2 required
SLOs_kql_with_filters_total
The KQL query used to define all events.
SLOs_group_by
optional group by field or fields to use to generate an SLO per distinct value
SLOs_indicator_properties_histogram
object
Defines properties for a histogram indicator type
2 properties2 required
SLOs_bulk_delete_request
object
The bulk delete SLO request takes a list of SLOs Definition id to delete.
1 property1 required
SLOs_delete_slo_instances_request
object
The delete SLO instances request takes a list of SLO id and instance id, then delete the rollup and summary data. This API can be used to remove the staled dat…
1 property1 required
SLOs_time_window
object
Defines properties for the SLO time window
2 properties2 required
SLOs_409_response
object
3 properties3 required
SLOs_objective
object
Defines properties for the SLO objective
3 properties1 required
SLOs_slo_with_summary_response
object
17 properties17 required
SLOs_timeslice_metric_basic_metric_with_field
object
4 properties3 required
SLOs_summary_status
string
SLOs_bulk_delete_status_response
object
Indicates if the bulk deletion is completed, with the detailed results of the operation.
3 properties
SLOs_timeslice_metric_percentile_metric
object
5 properties4 required
SLOs_indicator_properties_apm_latency
object
Defines properties for the APM latency indicator type
2 properties2 required
SLOs_401_response
object
3 properties3 required
SLOs_timeslice_metric_doc_count_metric
object
3 properties2 required
SLOs_filter_meta
object
Defines properties for a filter
12 properties
SLOs_create_slo_response
object
1 property1 required
SLOs_400_response
object
3 properties3 required
SLOs_bulk_purge_rollup_request
object
The bulk purge rollup data request takes a list of SLO ids and a purge policy, then deletes the rollup data according to the purge policy. This API can be used…
2 properties2 required
SLOs_indicator_properties_apm_availability
object
Defines properties for the APM availability indicator type
2 properties2 required
SLOs_budgeting_method
string
The budgeting method to use when computing the rollup data.
SLOs_kql_with_filters_good
The KQL query used to define the good events.
Specification
The full machine-readable OpenAPI contract behind this narrative.
