Skip to main content
Server path: /kibana-observability | Type: Application | PCID required: Yes

Tools

ToolDescription
kibana_observability_bulk_delete_opBulk delete SLO definitions and their associated summary and rollup data.
kibana_observability_bulk_delete_status_opRetrieve the status of the bulk deletion
kibana_observability_create_slo_opCreate an SLO
kibana_observability_delete_parameterDelete a parameter
kibana_observability_delete_parametersDelete parameters
kibana_observability_delete_private_locationDelete a private location
kibana_observability_delete_rollup_data_opBatch delete rollup and summary data
kibana_observability_delete_slo_instances_opBatch delete rollup and summary data
kibana_observability_delete_slo_opDelete an SLO
kibana_observability_delete_synthetic_monitorDelete a monitor
kibana_observability_delete_synthetic_monitorsDelete monitors
kibana_observability_disable_slo_opDisable an SLO
kibana_observability_enable_slo_opEnable an SLO
kibana_observability_find_slos_opGet a paginated list of SLOs
kibana_observability_get_parameterGet a parameter
kibana_observability_get_parametersGet parameters
kibana_observability_get_private_locationGet a private location
kibana_observability_get_private_locationsGet private locations
kibana_observability_get_slo_opGet an SLO
kibana_observability_get_synthetic_monitorGet a monitor
kibana_observability_get_synthetic_monitorsGet monitors
kibana_observability_post_parametersAdd parameters
kibana_observability_post_private_locationCreate a private location
kibana_observability_post_synthetic_monitorsCreate a monitor
kibana_observability_post_synthetics_monitor_testTrigger an on-demand test run for a monitor
kibana_observability_put_parameterUpdate a parameter
kibana_observability_put_private_locationUpdate a private location
kibana_observability_put_synthetic_monitorUpdate a monitor
kibana_observability_reset_slo_opReset an SLO
kibana_observability_update_slo_opUpdate an SLO

kibana_observability_bulk_delete_op

Bulk delete SLO definitions and their associated summary and rollup data. Parameters:
ParameterTypeRequiredDefaultDescription
spaceIdstringYesAn identifier for the space. If /s/ and the identifier are omitted from the path, the default space is used.
liststring[]YesAn array of SLO Definition id

kibana_observability_bulk_delete_status_op

Retrieve the status of the bulk deletion Parameters:
ParameterTypeRequiredDefaultDescription
spaceIdstringYesAn identifier for the space. If /s/ and the identifier are omitted from the path, the default space is used.
taskIdstringYesThe task id of the bulk delete operation

kibana_observability_create_slo_op

Create an SLO Parameters:
ParameterTypeRequiredDefaultDescription
spaceIdstringYesAn identifier for the space. If /s/ and the identifier are omitted from the path, the default space is used.
artifactsobjectNoLinks to related assets for the SLO
budgetingMethodstringYesThe budgeting method to use when computing the rollup data.
descriptionstringYesA description for the SLO.
groupBystring[]Nooptional group by field or fields to use to generate an SLO per distinct value
idstringNoA optional and unique identifier for the SLO. Must be between 8 and 36 chars
indicatorobjectYesThe indicator value
namestringYesA name for the SLO.
objectiveobjectYesDefines properties for the SLO objective
settingsobjectNoDefines properties for SLO settings.
tagsstring[]NoList of tags
timeWindowobjectYesDefines properties for the SLO time window

kibana_observability_delete_parameter

Delete a parameter Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe ID for the parameter to delete.

kibana_observability_delete_parameters

Delete parameters Parameters:
ParameterTypeRequiredDefaultDescription
idsstring[]NoAn array of parameter IDs to delete.

kibana_observability_delete_private_location

Delete a private location Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe unique identifier of the private location to be deleted.

kibana_observability_delete_rollup_data_op

Batch delete rollup and summary data Parameters:
ParameterTypeRequiredDefaultDescription
spaceIdstringYesAn identifier for the space. If /s/ and the identifier are omitted from the path, the default space is used.
liststring[]YesAn array of slo ids
purgePolicyobjectYesPolicy that dictates which SLI documents to purge based on age

kibana_observability_delete_slo_instances_op

Batch delete rollup and summary data Parameters:
ParameterTypeRequiredDefaultDescription
spaceIdstringYesAn identifier for the space. If /s/ and the identifier are omitted from the path, the default space is used.
listobject[]YesAn array of slo id and instance id

kibana_observability_delete_slo_op

Delete an SLO Parameters:
ParameterTypeRequiredDefaultDescription
spaceIdstringYesAn identifier for the space. If /s/ and the identifier are omitted from the path, the default space is used.
sloIdstringYesAn identifier for the slo.

kibana_observability_delete_synthetic_monitor

Delete a monitor Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe identifier for the monitor that you want to delete.

kibana_observability_delete_synthetic_monitors

Delete monitors Parameters:
ParameterTypeRequiredDefaultDescription
idsstring[]YesAn array of monitor IDs to delete.

kibana_observability_disable_slo_op

Disable an SLO Parameters:
ParameterTypeRequiredDefaultDescription
spaceIdstringYesAn identifier for the space. If /s/ and the identifier are omitted from the path, the default space is used.
sloIdstringYesAn identifier for the slo.

kibana_observability_enable_slo_op

Enable an SLO Parameters:
ParameterTypeRequiredDefaultDescription
spaceIdstringYesAn identifier for the space. If /s/ and the identifier are omitted from the path, the default space is used.
sloIdstringYesAn identifier for the slo.

kibana_observability_find_slos_op

Get a paginated list of SLOs Parameters:
ParameterTypeRequiredDefaultDescription
spaceIdstringYesAn identifier for the space. If /s/ and the identifier are omitted from the path, the default space is used.
kqlQuerystringNoA valid kql query to filter the SLO with
sizeintegerNoThe page size to use for cursor-based pagination, must be greater or equal than 1
searchAfterstring[]NoThe cursor to use for fetching the results from, when using a cursor-base pagination.
pageintegerNoThe page to use for pagination, must be greater or equal than 1
perPageintegerNoNumber of SLOs returned by page
sortBystringNoSort by field
sortDirectionstringNoSort order
hideStalebooleanNoHide stale SLOs from the list as defined by stale SLO threshold in SLO settings

kibana_observability_get_parameter

Get a parameter Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe unique identifier for the parameter.

kibana_observability_get_parameters

Get parameters

kibana_observability_get_private_location

Get a private location Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesA private location identifier or label.

kibana_observability_get_private_locations

Get private locations

kibana_observability_get_slo_op

Get an SLO Parameters:
ParameterTypeRequiredDefaultDescription
spaceIdstringYesAn identifier for the space. If /s/ and the identifier are omitted from the path, the default space is used.
sloIdstringYesAn identifier for the slo.
instanceIdstringNothe specific instanceId used by the summary calculation

kibana_observability_get_synthetic_monitor

Get a monitor Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe ID of the monitor.

kibana_observability_get_synthetic_monitors

Get monitors Parameters:
ParameterTypeRequiredDefaultDescription
filterstringNoAdditional filtering criteria.
locationsobjectNoThe locations to filter by.
monitorTypesobjectNoThe monitor types to filter.
pageintegerNoThe page number for paginated results.
per_pageintegerNoThe number of items to return per page.
projectsobjectNoThe projects to filter by.
querystringNoA free-text query string.
schedulesobjectNoThe schedules to filter by.
sortFieldstringNoThe field to sort the results by.
sortOrderstringNoThe sort order.
statusobjectNoThe status to filter by.
tagsobjectNoTags to filter monitors.
useLogicalAndForstring[]NoSpecifies whether to apply logical AND filtering for specific fields. Accepts either a string with values “tags” or “locations” or an array containing both.

kibana_observability_post_parameters

Add parameters Parameters:
ParameterTypeRequiredDefaultDescription
bodyobject[]YesThe request body can contain either a single parameter object or an array of parameter objects.

kibana_observability_post_private_location

Create a private location Parameters:
ParameterTypeRequiredDefaultDescription
agentPolicyIdstringYesThe ID of the agent policy associated with the private location.
geoobjectNoGeographic coordinates (WGS84) for the location.
labelstringYesA label for the private location.
spacesstring[]NoAn array of space IDs where the private location is available. If it is not provided, the private location is available in all spaces.
tagsstring[]NoAn array of tags to categorize the private location.

kibana_observability_post_synthetic_monitors

Create a monitor Parameters:
ParameterTypeRequiredDefaultDescription
bodyobjectYesThe request body should contain the attributes of the monitor you want to create. The required and default fields differ depending on the monitor type.

kibana_observability_post_synthetics_monitor_test

Trigger an on-demand test run for a monitor Parameters:
ParameterTypeRequiredDefaultDescription
monitorIdstringYesThe ID (config_id) of the monitor to test.

kibana_observability_put_parameter

Update a parameter Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe unique identifier for the parameter.
descriptionstringNoThe updated description of the parameter.
keystringNoThe key of the parameter.
tagsstring[]NoAn array of updated tags to categorize the parameter.
valuestringNoThe updated value associated with the parameter.

kibana_observability_put_private_location

Update a private location Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe unique identifier of the private location to be updated.
labelstringYesA new label for the private location. Must be at least 1 character long.

kibana_observability_put_synthetic_monitor

Update a monitor Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe identifier for the monitor that you want to update.
bodyobjectYesThe request body should contain the attributes of the monitor you want to update. The required and default fields differ depending on the monitor type.

kibana_observability_reset_slo_op

Reset an SLO Parameters:
ParameterTypeRequiredDefaultDescription
spaceIdstringYesAn identifier for the space. If /s/ and the identifier are omitted from the path, the default space is used.
sloIdstringYesAn identifier for the slo.

kibana_observability_update_slo_op

Update an SLO Parameters:
ParameterTypeRequiredDefaultDescription
spaceIdstringYesAn identifier for the space. If /s/ and the identifier are omitted from the path, the default space is used.
sloIdstringYesAn identifier for the slo.
artifactsobjectNoLinks to related assets for the SLO
budgetingMethodstringNoThe budgeting method to use when computing the rollup data.
descriptionstringNoA description for the SLO.
groupBystring[]Nooptional group by field or fields to use to generate an SLO per distinct value
indicatorobjectNoThe indicator value
namestringNoA name for the SLO.
objectiveobjectNoDefines properties for the SLO objective
settingsobjectNoDefines properties for SLO settings.
tagsstring[]NoList of tags
timeWindowobjectNoDefines properties for the SLO time window