/kibana-observability | Type: Application | PCID required: Yes
Tools
kibana_observability_bulk_delete_op
Bulk delete SLO definitions and their associated summary and rollup data. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
spaceId | string | Yes | — | An identifier for the space. If /s/ and the identifier are omitted from the path, the default space is used. |
list | string[] | Yes | — | An array of SLO Definition id |
kibana_observability_bulk_delete_status_op
Retrieve the status of the bulk deletion Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
spaceId | string | Yes | — | An identifier for the space. If /s/ and the identifier are omitted from the path, the default space is used. |
taskId | string | Yes | — | The task id of the bulk delete operation |
kibana_observability_create_slo_op
Create an SLO Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
spaceId | string | Yes | — | An identifier for the space. If /s/ and the identifier are omitted from the path, the default space is used. |
artifacts | object | No | — | Links to related assets for the SLO |
budgetingMethod | string | Yes | — | The budgeting method to use when computing the rollup data. |
description | string | Yes | — | A description for the SLO. |
groupBy | string[] | No | — | optional group by field or fields to use to generate an SLO per distinct value |
id | string | No | — | A optional and unique identifier for the SLO. Must be between 8 and 36 chars |
indicator | object | Yes | — | The indicator value |
name | string | Yes | — | A name for the SLO. |
objective | object | Yes | — | Defines properties for the SLO objective |
settings | object | No | — | Defines properties for SLO settings. |
tags | string[] | No | — | List of tags |
timeWindow | object | Yes | — | Defines properties for the SLO time window |
kibana_observability_delete_parameter
Delete a parameter Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The ID for the parameter to delete. |
kibana_observability_delete_parameters
Delete parameters Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ids | string[] | No | — | An array of parameter IDs to delete. |
kibana_observability_delete_private_location
Delete a private location Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The unique identifier of the private location to be deleted. |
kibana_observability_delete_rollup_data_op
Batch delete rollup and summary data Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
spaceId | string | Yes | — | An identifier for the space. If /s/ and the identifier are omitted from the path, the default space is used. |
list | string[] | Yes | — | An array of slo ids |
purgePolicy | object | Yes | — | Policy that dictates which SLI documents to purge based on age |
kibana_observability_delete_slo_instances_op
Batch delete rollup and summary data Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
spaceId | string | Yes | — | An identifier for the space. If /s/ and the identifier are omitted from the path, the default space is used. |
list | object[] | Yes | — | An array of slo id and instance id |
kibana_observability_delete_slo_op
Delete an SLO Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
spaceId | string | Yes | — | An identifier for the space. If /s/ and the identifier are omitted from the path, the default space is used. |
sloId | string | Yes | — | An identifier for the slo. |
kibana_observability_delete_synthetic_monitor
Delete a monitor Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The identifier for the monitor that you want to delete. |
kibana_observability_delete_synthetic_monitors
Delete monitors Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ids | string[] | Yes | — | An array of monitor IDs to delete. |
kibana_observability_disable_slo_op
Disable an SLO Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
spaceId | string | Yes | — | An identifier for the space. If /s/ and the identifier are omitted from the path, the default space is used. |
sloId | string | Yes | — | An identifier for the slo. |
kibana_observability_enable_slo_op
Enable an SLO Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
spaceId | string | Yes | — | An identifier for the space. If /s/ and the identifier are omitted from the path, the default space is used. |
sloId | string | Yes | — | An identifier for the slo. |
kibana_observability_find_slos_op
Get a paginated list of SLOs Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
spaceId | string | Yes | — | An identifier for the space. If /s/ and the identifier are omitted from the path, the default space is used. |
kqlQuery | string | No | — | A valid kql query to filter the SLO with |
size | integer | No | — | The page size to use for cursor-based pagination, must be greater or equal than 1 |
searchAfter | string[] | No | — | The cursor to use for fetching the results from, when using a cursor-base pagination. |
page | integer | No | — | The page to use for pagination, must be greater or equal than 1 |
perPage | integer | No | — | Number of SLOs returned by page |
sortBy | string | No | — | Sort by field |
sortDirection | string | No | — | Sort order |
hideStale | boolean | No | — | Hide stale SLOs from the list as defined by stale SLO threshold in SLO settings |
kibana_observability_get_parameter
Get a parameter Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The unique identifier for the parameter. |
kibana_observability_get_parameters
Get parameterskibana_observability_get_private_location
Get a private location Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | A private location identifier or label. |
kibana_observability_get_private_locations
Get private locationskibana_observability_get_slo_op
Get an SLO Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
spaceId | string | Yes | — | An identifier for the space. If /s/ and the identifier are omitted from the path, the default space is used. |
sloId | string | Yes | — | An identifier for the slo. |
instanceId | string | No | — | the specific instanceId used by the summary calculation |
kibana_observability_get_synthetic_monitor
Get a monitor Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The ID of the monitor. |
kibana_observability_get_synthetic_monitors
Get monitors Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
filter | string | No | — | Additional filtering criteria. |
locations | object | No | — | The locations to filter by. |
monitorTypes | object | No | — | The monitor types to filter. |
page | integer | No | — | The page number for paginated results. |
per_page | integer | No | — | The number of items to return per page. |
projects | object | No | — | The projects to filter by. |
query | string | No | — | A free-text query string. |
schedules | object | No | — | The schedules to filter by. |
sortField | string | No | — | The field to sort the results by. |
sortOrder | string | No | — | The sort order. |
status | object | No | — | The status to filter by. |
tags | object | No | — | Tags to filter monitors. |
useLogicalAndFor | string[] | No | — | Specifies 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
body | object[] | Yes | — | The 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
agentPolicyId | string | Yes | — | The ID of the agent policy associated with the private location. |
geo | object | No | — | Geographic coordinates (WGS84) for the location. |
label | string | Yes | — | A label for the private location. |
spaces | string[] | No | — | An array of space IDs where the private location is available. If it is not provided, the private location is available in all spaces. |
tags | string[] | No | — | An array of tags to categorize the private location. |
kibana_observability_post_synthetic_monitors
Create a monitor Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
body | object | Yes | — | The 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
monitorId | string | Yes | — | The ID (config_id) of the monitor to test. |
kibana_observability_put_parameter
Update a parameter Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The unique identifier for the parameter. |
description | string | No | — | The updated description of the parameter. |
key | string | No | — | The key of the parameter. |
tags | string[] | No | — | An array of updated tags to categorize the parameter. |
value | string | No | — | The updated value associated with the parameter. |
kibana_observability_put_private_location
Update a private location Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The unique identifier of the private location to be updated. |
label | string | Yes | — | A new label for the private location. Must be at least 1 character long. |
kibana_observability_put_synthetic_monitor
Update a monitor Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The identifier for the monitor that you want to update. |
body | object | Yes | — | The 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
spaceId | string | Yes | — | An identifier for the space. If /s/ and the identifier are omitted from the path, the default space is used. |
sloId | string | Yes | — | An identifier for the slo. |
kibana_observability_update_slo_op
Update an SLO Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
spaceId | string | Yes | — | An identifier for the space. If /s/ and the identifier are omitted from the path, the default space is used. |
sloId | string | Yes | — | An identifier for the slo. |
artifacts | object | No | — | Links to related assets for the SLO |
budgetingMethod | string | No | — | The budgeting method to use when computing the rollup data. |
description | string | No | — | A description for the SLO. |
groupBy | string[] | No | — | optional group by field or fields to use to generate an SLO per distinct value |
indicator | object | No | — | The indicator value |
name | string | No | — | A name for the SLO. |
objective | object | No | — | Defines properties for the SLO objective |
settings | object | No | — | Defines properties for SLO settings. |
tags | string[] | No | — | List of tags |
timeWindow | object | No | — | Defines properties for the SLO time window |

