/kibana-security | Type: Application | PCID required: Yes
Tools
kibana_security_create_alerts_index
Create an alerts indexkibana_security_create_list
Create a value list Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
description | string | Yes | — | Describes the value list. |
id | string | No | — | Value list’s identifier. |
meta | object | No | — | Placeholder for metadata about the value list. |
name | string | Yes | — | Value list’s name. |
type | string | Yes | — | Specifies the Elasticsearch data type of excludes the list container holds. Some common examples: - keyword: Many ECS fields are Elasticsearch keywords - ip: IP addresses - ip_range: Range of IP addresses (supports IPv4, IPv6, and CIDR notation) |
version | integer | No | — | The version value |
kibana_security_create_list_item
Create a value list item Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | No | — | Value list item’s identifier. |
list_id | string | Yes | — | Value list’s identifier. |
meta | object | No | — | Placeholder for metadata about the value list item. |
refresh | string | No | — | Determines when changes made by the request are made visible to search. |
value | string | Yes | — | The value used to evaluate exceptions. |
kibana_security_create_rule
Create a detection rule Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
body | object | Yes | — | Request body |
kibana_security_delete_alerts_index
Delete an alerts indexkibana_security_delete_list
Delete a value list Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Value list’s identifier. |
deleteReferences | boolean | No | — | Determines whether exception items referencing this value list should be deleted. |
ignoreReferences | boolean | No | — | Determines whether to delete value list without performing any additional checks of where this list may be utilized. |
kibana_security_delete_list_index
Delete value list data streamskibana_security_delete_list_item
Delete a value list item Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | No | — | Value list item’s identifier. Required if list_id and value are not specified. |
list_id | string | No | — | Value list’s identifier. Required if id is not specified. |
value | string | No | — | The value used to evaluate exceptions. Required if id is not specified. |
refresh | string | No | — | Determines when changes made by the request are made visible to search. |
kibana_security_delete_rule
Delete a detection rule Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | No | — | The rule’s id value. |
rule_id | string | No | — | The rule’s rule_id value. |
kibana_security_export_list_items
Export value list items Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
list_id | string | Yes | — | Value list’s id to export. |
kibana_security_export_rules
Export detection rules Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
exclude_export_details | boolean | No | — | Determines whether a summary of the exported rules is returned. |
file_name | string | No | — | File name for saving the exported rules. > info > When using cURL to export rules to a file, use the -O and -J options to save the rules to the file name specified in the URL. |
objects | object[] | No | — | Array of objects with a rule’s rule_id field. Do not use rule’s id here. Exports all rules when unspecified. |
kibana_security_find_list_items
Get value list items Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
list_id | string | Yes | — | Value list’s identifier. |
page | integer | No | — | The page number to return. |
per_page | integer | No | — | The number of list items to return per page. |
sort_field | string | No | — | Determines which field is used to sort the results. |
sort_order | string | No | — | Determines the sort order, which can be desc or asc |
cursor | string | No | — | Returns the items that come after the last item returned in the previous call (use the cursor value returned in the previous call). This parameter uses the tie_breaker_id field to ensure all items are sorted and returned correctly. |
filter | string | No | — | Filters the returned results according to the value of the specified field, using the <field name>:<field value> syntax. |
kibana_security_find_lists
Get value lists Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | The page number to return. |
per_page | integer | No | — | The number of value lists to return per page. |
sort_field | string | No | — | Determines which field is used to sort the results. |
sort_order | string | No | — | Determines the sort order, which can be desc or asc |
cursor | string | No | — | Returns the lists that come after the last lists returned in the previous call (use the cursor value returned in the previous call). This parameter uses the tie_breaker_id field to ensure all lists are sorted and returned correctly. |
filter | string | No | — | Filters the returned results according to the value of the specified field, using the <field name>:<field value> syntax. |
kibana_security_find_rules
List all detection rules Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fields | string[] | No | — | The fields value |
filter | string | No | — | Search query Filters the returned results according to the value of the specified field, using the alert.attributes.<field name>:<field value> syntax, where <field name> can be: - name - enabled - tags - createdBy - interval - updatedBy > info > Even though the JSON rule object uses created_by and updated_by fields, you must use createdBy and updatedBy fields in the filter. |
sort_field | string | No | — | Field to sort by |
sort_order | string | No | — | Sort order |
page | integer | No | — | Page number |
per_page | integer | No | — | Rules per page |
gaps_range_start | string | No | — | Gaps range start |
gaps_range_end | string | No | — | Gaps range end |
gap_fill_statuses | string[] | No | — | Gap fill statuses |
gap_auto_fill_scheduler_id | string | No | — | Gap auto fill scheduler ID used to determine gap fill status for rules |
kibana_security_import_list_items
Import value list items Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
list_id | string | No | — | List’s id. Required when importing to an existing list. |
type | string | No | — | Type of the importing list. Required when importing a new list whose list id is not specified. |
refresh | string | No | — | Determines when changes made by the request are made visible to search. |
file | string | No | — | A .txt or .csv file containing newline separated list items. |
kibana_security_import_rules
Import detection rules Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
overwrite | boolean | No | — | Determines whether existing rules with the same rule_id are overwritten. |
overwrite_exceptions | boolean | No | — | Determines whether existing exception lists with the same list_id are overwritten. Both the exception list container and its items are overwritten. |
overwrite_action_connectors | boolean | No | — | Determines whether existing actions with the same kibana.alert.rule.actions.id are overwritten. |
as_new_list | boolean | No | — | Generates a new list ID for each imported exception list. |
file | string | No | — | The .ndjson file containing the rules. |
kibana_security_install_prebuilt_rules_and_timelines
Install prebuilt detection rules and Timelineskibana_security_patch_list
Patch a value list Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
_version | string | No | — | The version id, normally returned by the API when the document is retrieved. Use it ensure updates are done against the latest version. |
description | string | No | — | Describes the value list. |
id | string | Yes | — | Value list’s identifier. |
meta | object | No | — | Placeholder for metadata about the value list. |
name | string | No | — | Value list’s name. |
version | integer | No | — | The document version number. |
kibana_security_patch_list_item
Patch a value list item Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
_version | string | No | — | The version id, normally returned by the API when the document is retrieved. Use it ensure updates are done against the latest version. |
id | string | Yes | — | Value list item’s identifier. |
meta | object | No | — | Placeholder for metadata about the value list item. |
refresh | string | No | — | Determines when changes made by the request are made visible to search. |
value | string | No | — | The value used to evaluate exceptions. |
kibana_security_patch_rule
Patch a detection rule Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
body | object | Yes | — | > info > You cannot modify the id or rule_id values. |
kibana_security_perform_rules_bulk_action
Apply a bulk action to detection rules Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
dry_run | boolean | No | — | Enables dry run mode for the request call. Enable dry run mode to verify that bulk actions can be applied to specified rules. Certain rules, such as prebuilt Elastic rules on a Basic subscription, can’t be edited and will return errors in the request response. Error details will contain an explanation, the rule name and/or ID, and additional troubleshooting information. To enable dry run mode on a request, add the query parameter dry_run=true to the end of the request URL. Rules specified in the request will be temporarily updated. These updates won’t be written to Elasticsearch. > info > Dry run mode is not supported for the export bulk action. A 400 error will be returned in the request response. |
body | object | No | — | Request body |
kibana_security_read_alerts_index
Reads the alert index name if it existskibana_security_read_list
Get value list details Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Value list’s identifier. |
kibana_security_read_list_index
Get status of value list data streamskibana_security_read_list_item
Get a value list item Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | No | — | Value list item identifier. Required if list_id and value are not specified. |
list_id | string | No | — | Value list item list’s id identfier. Required if id is not specified. |
value | string | No | — | The value used to evaluate exceptions. Required if id is not specified. |
kibana_security_read_list_privileges
Get value list privilegeskibana_security_read_prebuilt_rules_and_timelines_status
Retrieve the status of prebuilt detection rules and Timelineskibana_security_read_privileges
Returns user privileges for the Kibana spacekibana_security_read_rule
Retrieve a detection rule Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | No | — | The rule’s id value. |
rule_id | string | No | — | The rule’s rule_id value. |
kibana_security_read_tags
List all detection rule tagskibana_security_rule_preview
Preview rule alerts generated on specified time range Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
enable_logged_requests | boolean | No | — | Enables logging and returning in response ES queries, performed during rule execution |
body | object | Yes | — | An object containing tags to add or remove and alert ids the changes will be applied |
kibana_security_search_alerts
Find and/or aggregate detection alerts Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
_source | object | No | — | The source value |
aggs | object | No | — | The aggs value |
fields | string[] | No | — | The fields value |
query | object | No | — | Search query string |
runtime_mappings | object | No | — | Runtime Mappings |
size | integer | No | — | The size value |
sort | object | No | — | Sort order for results |
track_total_hits | boolean | No | — | Track Total Hits |
kibana_security_set_alert_assignees
Assign and unassign users from detection alerts Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
assignees | object | Yes | — | The assignees value |
ids | string[] | Yes | — | A list of alerts ids. |
kibana_security_set_alert_tags
Add and remove detection alert tags Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ids | string[] | Yes | — | A list of alerts ids. |
tags | object | Yes | — | Object with list of tags to add and remove. |
kibana_security_set_alerts_status
Set a detection alert status Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
body | object | Yes | — | An object containing desired status and explicit alert ids or a query to select alerts |
kibana_security_update_list
Update a value list Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
_version | string | No | — | The version id, normally returned by the API when the document is retrieved. Use it ensure updates are done against the latest version. |
description | string | Yes | — | Describes the value list. |
id | string | Yes | — | Value list’s identifier. |
meta | object | No | — | Placeholder for metadata about the value list. |
name | string | Yes | — | Value list’s name. |
version | integer | No | — | The document version number. |
kibana_security_update_list_item
Update a value list item Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
_version | string | No | — | The version id, normally returned by the API when the document is retrieved. Use it ensure updates are done against the latest version. |
id | string | Yes | — | Value list item’s identifier. |
meta | object | No | — | Placeholder for metadata about the value list item. |
value | string | Yes | — | The value used to evaluate exceptions. |
kibana_security_update_rule
Update a detection rule Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
body | object | Yes | — | > info > All unspecified fields are deleted. You cannot modify the id or rule_id values. |

