(Deprecated) List detection alerts
Action ID:tools.elastic_security.list_detection_signals
Deprecated compatibility action. Use tools.elastic_security.search_detection_alerts for API-native alert searches.
Reference: https://www.elastic.co/docs/api/doc/kibana/v8/operation/operation-searchalerts
Deprecated: Use tools.elastic_security.search_detection_alerts for API-native alert searches.
Secrets
Required secrets:elastic_security: required valuesELASTIC_API_KEY.
Input fields
Kibana endpoint URL (e.g. https://localhost:5601).Default:
null.Elastic JSON query DSL. If specified, overrides
start_time and end_time.Default: null.Source field filter applied to each alert. Pass a list of dotted field
names to include only those fields, or a dict of
includes / excludes
for fine-grained control. Maps directly to the Kibana _source request
body parameter. When null (default), every field is returned.Default: null.Assign attack users
Action ID:tools.elastic_security.assign_attack_users
Assign or unassign users on Attack Discovery attack alerts. Requires Kibana 9.5+.
Reference: https://www.elastic.co/docs/api/doc/kibana/operation/operation-setattacksassignees
Secrets
Required secrets:elastic_security: required valuesELASTIC_API_KEY.
Input fields
Kibana base URL (e.g. https://localhost:5601).Default:
null.When
true, the change is also applied to detection alerts related to the attacks.Default: false.Assign detection alert users
Action ID:tools.elastic_security.assign_detection_alert_users
Assign or unassign users on Elastic Security detection alerts.
Reference: https://www.elastic.co/docs/api/doc/kibana/operation/operation-setalertassignees
Secrets
Required secrets:elastic_security: required valuesELASTIC_API_KEY.
Input fields
Details about the assignees to assign and unassign. Requires
add and remove, each a list of user profile uids to assign or unassign. Users need to activate their user profile by logging into Kibana at least once.Kibana base URL (e.g. https://localhost:5601).Default:
null.Bulk action detection rules
Action ID:tools.elastic_security.bulk_action_detection_rules
Apply a bulk action to Elastic Security detection rules.
Reference: https://www.elastic.co/docs/api/doc/kibana/operation/operation-performrulesbulkaction
Secrets
Required secrets:elastic_security: required valuesELASTIC_API_KEY.
Input fields
Kibana base URL (e.g. https://localhost:5601).Default:
null.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. Rules specified in the request will be temporarily updated. These updates won’t be written to Elasticsearch. Dry run mode is not supported for the
export bulk action.Default: null.Cancel response action
Action ID:tools.elastic_security.cancel_response_action
Cancel an Elastic Endpoint response action. Requires Kibana 9.2+.
Reference: https://www.elastic.co/docs/api/doc/kibana/operation/operation-cancelaction
Secrets
Required secrets:elastic_security: required valuesELASTIC_API_KEY.
Input fields
API-native request body. Documented fields: endpoint_ids (required), parameters (required), agent_type, alert_ids, case_ids, comment.
Kibana base URL (e.g. https://localhost:5601).Default:
null.Create detection rule
Action ID:tools.elastic_security.create_detection_rule
Create an Elastic Security detection rule.
Reference: https://www.elastic.co/docs/api/doc/kibana/operation/operation-createrule
Secrets
Required secrets:elastic_security: required valuesELASTIC_API_KEY.
Input fields
Kibana base URL (e.g. https://localhost:5601).Default:
null.Create endpoint script
Action ID:tools.elastic_security.create_endpoint_script
Create a script in the Elastic Endpoint response script library. Requires Kibana 9.4+.
Reference: https://www.elastic.co/docs/api/doc/kibana/operation/operation-endpointscriptlibrarycreatescript
Secrets
Required secrets:elastic_security: required valuesELASTIC_API_KEY.
Input fields
Kibana base URL (e.g. https://localhost:5601).Default:
null.Create exception list
Action ID:tools.elastic_security.create_exception_list
Create an Elastic Security exception list.
Reference: https://www.elastic.co/docs/api/doc/kibana/operation/operation-createexceptionlist
Secrets
Required secrets:elastic_security: required valuesELASTIC_API_KEY.
Input fields
Kibana base URL (e.g. https://localhost:5601).Default:
null.Create exception list item
Action ID:tools.elastic_security.create_exception_list_item
Create an item in an Elastic Security exception list.
Reference: https://www.elastic.co/docs/api/doc/kibana/operation/operation-createexceptionlistitem
Secrets
Required secrets:elastic_security: required valuesELASTIC_API_KEY.
Input fields
Kibana base URL (e.g. https://localhost:5601).Default:
null.Create or update note
Action ID:tools.elastic_security.create_or_update_note
Add a note to an alert/event or Timeline, or update an existing note.
Reference: https://www.elastic.co/docs/api/doc/kibana/operation/operation-persistnoteroute
Secrets
Required secrets:elastic_security: required valuesELASTIC_API_KEY.
Input fields
API-native JSON request body. Requires
note (e.g. note text, eventId for an alert/event, timelineId); pass noteId and version to update an existing note.Kibana base URL (e.g. https://localhost:5601).Default:
null.Create timeline
Action ID:tools.elastic_security.create_timeline
Create an Elastic Security Timeline or Timeline template.
Reference: https://www.elastic.co/docs/api/doc/kibana/operation/operation-createtimelines
Secrets
Required secrets:elastic_security: required valuesELASTIC_API_KEY.
Input fields
API-native JSON request body. Requires
timeline (e.g. title, description, dataProviders, kqlQuery, dateRange); optional status, timelineId, timelineType, templateTimelineId, templateTimelineVersion, version.Kibana base URL (e.g. https://localhost:5601).Default:
null.Create value list
Action ID:tools.elastic_security.create_value_list
Create an Elastic Security value list, e.g. an IP or keyword blocklist referenced by exception items.
Reference: https://www.elastic.co/docs/api/doc/kibana/operation/operation-createlist
Secrets
Required secrets:elastic_security: required valuesELASTIC_API_KEY.
Input fields
API-native JSON request body. Requires
name, description, and type (e.g. ip, ip_range, keyword, text); optional id, meta, version.Kibana base URL (e.g. https://localhost:5601).Default:
null.Create value list item
Action ID:tools.elastic_security.create_value_list_item
Add a value (e.g. an IOC) to an Elastic Security value list.
Reference: https://www.elastic.co/docs/api/doc/kibana/operation/operation-createlistitem
Secrets
Required secrets:elastic_security: required valuesELASTIC_API_KEY.
Input fields
API-native JSON request body. Requires
list_id and value; optional id, meta, and refresh (true, false, or wait_for).Kibana base URL (e.g. https://localhost:5601).Default:
null.Delete detection rule
Action ID:tools.elastic_security.delete_detection_rule
Delete an Elastic Security detection rule by id or rule_id.
Reference: https://www.elastic.co/docs/api/doc/kibana/operation/operation-deleterule
Secrets
Required secrets:elastic_security: required valuesELASTIC_API_KEY.
Input fields
Kibana base URL (e.g. https://localhost:5601).Default:
null.Delete exception list item
Action ID:tools.elastic_security.delete_exception_list_item
Delete an Elastic Security exception list item.
Reference: https://www.elastic.co/docs/api/doc/kibana/operation/operation-deleteexceptionlistitem
Secrets
Required secrets:elastic_security: required valuesELASTIC_API_KEY.
Input fields
Kibana base URL (e.g. https://localhost:5601).Default:
null.Human readable exception item string identifier, e.g.
trusted-linux-processes. Either id or item_id must be specified.Default: null.single deletes the item in the current Kibana space; agnostic deletes an item in a space-agnostic list. Must match the list that owns the item. Defaults to single.Default: null.Delete value list item
Action ID:tools.elastic_security.delete_value_list_item
Delete an Elastic Security value list item by id, or by list_id and value.
Reference: https://www.elastic.co/docs/api/doc/kibana/operation/operation-deletelistitem
Secrets
Required secrets:elastic_security: required valuesELASTIC_API_KEY.
Input fields
Kibana base URL (e.g. https://localhost:5601).Default:
null.Value list item identifier. Required if
list_id and value are not specified.Default: null.Determines when changes are visible to search. Possible values: true, false, wait_for.Default:
null.Download response file
Action ID:tools.elastic_security.download_response_file
Download a response-action file as base64.
Reference: https://www.elastic.co/docs/api/doc/kibana/operation/operation-endpointfiledownload
Secrets
Required secrets:elastic_security: required valuesELASTIC_API_KEY.
Input fields
Kibana base URL (e.g. https://localhost:5601).Default:
null.Export detection rules
Action ID:tools.elastic_security.export_detection_rules
Export Elastic Security detection rules as NDJSON text.
Reference: https://www.elastic.co/docs/api/doc/kibana/operation/operation-exportrules
Secrets
Required secrets:elastic_security: required valuesELASTIC_API_KEY.
Input fields
Kibana base URL (e.g. https://localhost:5601).Default:
null.Determines whether a summary of the exported rules is returned. Defaults to
false.Default: null.Generate endpoint memory dump
Action ID:tools.elastic_security.generate_endpoint_memory_dump
Generate a memory dump on an Elastic Endpoint. Requires Kibana 9.3+.
Reference: https://www.elastic.co/docs/api/doc/kibana/operation/operation-endpointgeneratememorydump
Secrets
Required secrets:elastic_security: required valuesELASTIC_API_KEY.
Input fields
API-native request body. Documented fields: endpoint_ids (required), parameters (required), agent_type, alert_ids, case_ids, comment.
Kibana base URL (e.g. https://localhost:5601).Default:
null.Get detection rule
Action ID:tools.elastic_security.get_detection_rule
Get an Elastic Security detection rule by id or rule_id.
Reference: https://www.elastic.co/docs/api/doc/kibana/operation/operation-readrule
Secrets
Required secrets:elastic_security: required valuesELASTIC_API_KEY.
Input fields
Kibana base URL (e.g. https://localhost:5601).Default:
null.Get endpoint
Action ID:tools.elastic_security.get_endpoint
Get Elastic Endpoint metadata by endpoint ID.
Reference: https://www.elastic.co/docs/api/doc/kibana/operation/operation-getendpointmetadata
Secrets
Required secrets:elastic_security: required valuesELASTIC_API_KEY.
Input fields
Kibana base URL (e.g. https://localhost:5601).Default:
null.Get endpoint file
Action ID:tools.elastic_security.get_endpoint_file
Request a file from one or more Elastic Endpoints.
Reference: https://www.elastic.co/docs/api/doc/kibana/operation/operation-endpointgetfileaction
Secrets
Required secrets:elastic_security: required valuesELASTIC_API_KEY.
Input fields
API-native request body. Documented fields: endpoint_ids (required), path (required), agent_type, alert_ids, case_ids, comment.
Kibana base URL (e.g. https://localhost:5601).Default:
null.Get endpoint processes
Action ID:tools.elastic_security.get_endpoint_processes
Get running processes from one or more Elastic Endpoints.
Reference: https://www.elastic.co/docs/api/doc/kibana/operation/operation-endpointgetprocessesaction
Secrets
Required secrets:elastic_security: required valuesELASTIC_API_KEY.
Input fields
API-native request body. Documented fields: endpoint_ids (required), agent_type, alert_ids, case_ids, comment.
Kibana base URL (e.g. https://localhost:5601).Default:
null.Get osquery live query
Action ID:tools.elastic_security.get_osquery_live_query
Get an osquery live query’s details, including the action ID of each query in the pack, to use with get_osquery_live_query_results.
Reference: https://www.elastic.co/docs/api/doc/kibana/operation/operation-osquerygetlivequerydetails
Secrets
Required secrets:elastic_security: required valuesELASTIC_API_KEY.
Input fields
Kibana base URL (e.g. https://localhost:5601).Default:
null.Get osquery live query results
Action ID:tools.elastic_security.get_osquery_live_query_results
Get the result rows of one query in an osquery live query. One page per call.
Reference: https://www.elastic.co/docs/api/doc/kibana/operation/operation-osquerygetlivequeryresults
Secrets
Required secrets:elastic_security: required valuesELASTIC_API_KEY.
Input fields
Kibana base URL (e.g. https://localhost:5601).Default:
null.Get response action
Action ID:tools.elastic_security.get_response_action
Get an Elastic Endpoint response action by ID.
Reference: https://www.elastic.co/docs/api/doc/kibana/operation/operation-endpointgetactionsdetails
Secrets
Required secrets:elastic_security: required valuesELASTIC_API_KEY.
Input fields
Kibana base URL (e.g. https://localhost:5601).Default:
null.Get response file info
Action ID:tools.elastic_security.get_response_file_info
Get information about a file returned by an Endpoint response action.
Reference: https://www.elastic.co/docs/api/doc/kibana/operation/operation-endpointfileinfo
Secrets
Required secrets:elastic_security: required valuesELASTIC_API_KEY.
Input fields
Kibana base URL (e.g. https://localhost:5601).Default:
null.Get timeline
Action ID:tools.elastic_security.get_timeline
Get an Elastic Security Timeline by id, or a Timeline template by template_timeline_id.
Reference: https://www.elastic.co/docs/api/doc/kibana/operation/operation-gettimeline
Secrets
Required secrets:elastic_security: required valuesELASTIC_API_KEY.
Input fields
Kibana base URL (e.g. https://localhost:5601).Default:
null.Get value list
Action ID:tools.elastic_security.get_value_list
Get an Elastic Security value list by ID.
Reference: https://www.elastic.co/docs/api/doc/kibana/operation/operation-readlist
Secrets
Required secrets:elastic_security: required valuesELASTIC_API_KEY.
Input fields
Kibana base URL (e.g. https://localhost:5601).Default:
null.Get value list item
Action ID:tools.elastic_security.get_value_list_item
Get an Elastic Security value list item by id, or by list_id and value.
Reference: https://www.elastic.co/docs/api/doc/kibana/operation/operation-readlistitem
Secrets
Required secrets:elastic_security: required valuesELASTIC_API_KEY.
Input fields
Kibana base URL (e.g. https://localhost:5601).Default:
null.Value list item identifier. Required if
list_id and value are not specified.Default: null.Import detection rules
Action ID:tools.elastic_security.import_detection_rules
Import Elastic Security detection rules from an NDJSON file.
Reference: https://www.elastic.co/docs/api/doc/kibana/operation/operation-importrules
Secrets
Required secrets:elastic_security: required valuesELASTIC_API_KEY.
Input fields
Generates a new list ID for each imported exception list. Defaults to
false.Default: null.Kibana base URL (e.g. https://localhost:5601).Default:
null.Determines whether existing rules with the same
rule_id are overwritten. Defaults to false.Default: null.Determines whether existing actions with the same
kibana.alert.rule.actions.id are overwritten. Defaults to false.Default: null.Determines whether existing exception lists with the same
list_id are overwritten. Both the exception list container and its items are overwritten. Defaults to false.Default: null.Isolate endpoint
Action ID:tools.elastic_security.isolate_endpoint
Isolate one or more Elastic Endpoints from the network.
Reference: https://www.elastic.co/docs/api/doc/kibana/operation/operation-endpointisolateaction
Secrets
Required secrets:elastic_security: required valuesELASTIC_API_KEY.
Input fields
API-native request body. Documented fields: endpoint_ids (required), agent_type, alert_ids, case_ids, comment.
Kibana base URL (e.g. https://localhost:5601).Default:
null.List detection rules
Action ID:tools.elastic_security.list_detection_rules
List Elastic Security detection rules.
Reference: https://www.elastic.co/docs/api/doc/kibana/operation/operation-findrules
Secrets
Required secrets:elastic_security: required valuesELASTIC_API_KEY.
Input fields
Kibana base URL (e.g. https://localhost:5601).Default:
null.List of
alert.attributes field names to return for each rule (for example name, enabled). If omitted, the default field set is returned.Default: null.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. Even though the JSON rule object uses created_by and updated_by fields, you must use createdBy and updatedBy fields in the filter.Default: null.Gap fill statuses. Possible values: unfilled, in_progress, filled, error.Default:
null.Field to sort by. Possible values: created_at, createdAt, enabled, execution_summary.last_execution.date, execution_summary.last_execution.metrics.execution_gap_duration_s, execution_summary.last_execution.metrics.total_indexing_duration_ms, execution_summary.last_execution.metrics.total_search_duration_ms, execution_summary.last_execution.status, name, risk_score, riskScore, severity, updated_at, updatedAt.Default:
null.List endpoint scripts
Action ID:tools.elastic_security.list_endpoint_scripts
List scripts in the Elastic Endpoint response script library. Requires Kibana 9.3+.
Reference: https://www.elastic.co/docs/api/doc/kibana/operation/operation-endpointscriptlibrarylistscripts
Secrets
Required secrets:elastic_security: required valuesELASTIC_API_KEY.
Input fields
Kibana base URL (e.g. https://localhost:5601).Default:
null.A KQL query string to filter the list of scripts. Nearly all fields in the script object are searchable.Default:
null.Number of results to return per page. Defaults to 10. Max value is 1000.Default:
null.The direction to sort the results by. Defaults to asc (ascending). Allowed values are
asc, desc.Default: null.The field to sort the results by. Defaults to name. Allowed values are
name, createdAt, createdBy, updatedAt, updatedBy, fileSize.Default: null.List endpoints
Action ID:tools.elastic_security.list_endpoints
List Elastic Endpoint metadata.
Reference: https://www.elastic.co/docs/api/doc/kibana/operation/operation-getendpointmetadatalist
Secrets
Required secrets:elastic_security: required valuesELASTIC_API_KEY.
Input fields
A set of host statuses to filter the results by (for example,
healthy, updating). Allowed values are healthy, offline, updating, inactive, unenrolled.Kibana base URL (e.g. https://localhost:5601).Default:
null.The field used to sort the results. Allowed values are
enrolled_at, metadata.host.hostname, host_status, metadata.Endpoint.policy.applied.name, metadata.Endpoint.policy.applied.status, metadata.host.os.name, metadata.host.ip, metadata.agent.version, last_checkin.Default: null.List exception list items
Action ID:tools.elastic_security.list_exception_list_items
List exception conditions within exception-list containers.
Reference: https://www.elastic.co/docs/api/doc/kibana/operation/operation-findexceptionlistitems
Secrets
Required secrets:elastic_security: required valuesELASTIC_API_KEY.
Input fields
Kibana base URL (e.g. https://localhost:5601).Default:
null.Filters the returned results according to the value of the specified field, using the
<field name>:<field value> syntax.Default: null.Determines whether the returned containers are Kibana associated with a Kibana space or available in all spaces. Possible values: agnostic, single.Default:
null.Free-text search term applied to exception list item fields (for example a hostname or file path fragment).Default:
null.List exception lists
Action ID:tools.elastic_security.list_exception_lists
List exception-list containers and metadata. This does not return their exception items.
Reference: https://www.elastic.co/docs/api/doc/kibana/operation/operation-findexceptionlists
Secrets
Required secrets:elastic_security: required valuesELASTIC_API_KEY.
Input fields
Kibana base URL (e.g. https://localhost:5601).Default:
null.Filters the returned results according to the value of the specified field. Uses the
so type.field name:field value syntax, where so type can be: exception-list (specify a space-aware exception list) or exception-list-agnostic (specify an exception list that is shared across spaces).Default: null.Determines whether the returned containers are Kibana associated with a Kibana space or available in all spaces. Possible values: agnostic, single.Default:
null.List notes
Action ID:tools.elastic_security.list_notes
List Elastic Security notes, or get the notes attached to specific alerts/events or Timelines.
Reference: https://www.elastic.co/docs/api/doc/kibana/operation/operation-getnotes
Secrets
Required secrets:elastic_security: required valuesELASTIC_API_KEY.
Input fields
How notes relate to a Timeline and/or event (list mode only). Possible values: all, document_only, saved_object_only, document_and_saved_object, orphan.Default:
null.Kibana base URL (e.g. https://localhost:5601).Default:
null.List response actions
Action ID:tools.elastic_security.list_response_actions
List Elastic Endpoint response actions.
Reference: https://www.elastic.co/docs/api/doc/kibana/operation/operation-endpointgetactionslist
Secrets
Required secrets:elastic_security: required valuesELASTIC_API_KEY.
Input fields
The agent type to filter response actions by. Defaults to
endpoint. Allowed values are endpoint, sentinel_one, crowdstrike, microsoft_defender_endpoint.Default: null.Kibana base URL (e.g. https://localhost:5601).Default:
null.A list of response action command names to filter by. Allowed values are
isolate, unisolate, kill-process, suspend-process, running-processes, get-file, execute, upload, scan, runscript, cancel, memory-dump.Default: null.A start date in ISO 8601 format or Date Math format (for example,
now-24h).Default: null.A list of response action IDs whose outputs should be included in the response.Default:
null.List timelines
Action ID:tools.elastic_security.list_timelines
List Elastic Security Timelines or Timeline templates. One page per call.
Reference: https://www.elastic.co/docs/api/doc/kibana/operation/operation-gettimelines
Secrets
Required secrets:elastic_security: required valuesELASTIC_API_KEY.
Input fields
Kibana base URL (e.g. https://localhost:5601).Default:
null.If
true, only Timelines the current user marked as favorite are returned.Default: null.List value list items
Action ID:tools.elastic_security.list_value_list_items
List the items in an Elastic Security value list.
Reference: https://www.elastic.co/docs/api/doc/kibana/operation/operation-findlistitems
Secrets
Required secrets:elastic_security: required valuesELASTIC_API_KEY.
Input fields
Kibana base URL (e.g. https://localhost:5601).Default:
null.Cursor returned by a previous call; pass it to continue listing from the next page.Default:
null.Filters the returned results according to the value of the specified field, using the
<field name>:<field value> syntax.Default: null.List value lists
Action ID:tools.elastic_security.list_value_lists
List Elastic Security value lists (used by exceptions and indicator-match rules).
Reference: https://www.elastic.co/docs/api/doc/kibana/operation/operation-findlists
Secrets
Required secrets:elastic_security: required valuesELASTIC_API_KEY.
Input fields
Kibana base URL (e.g. https://localhost:5601).Default:
null.Cursor returned by a previous call; pass it to continue listing from the next page.Default:
null.Filters the returned results according to the value of the specified field, using the
<field name>:<field value> syntax.Default: null.Patch detection rule
Action ID:tools.elastic_security.patch_detection_rule
Partially update an Elastic Security detection rule.
Reference: https://www.elastic.co/docs/api/doc/kibana/operation/operation-patchrule
Secrets
Required secrets:elastic_security: required valuesELASTIC_API_KEY.
Input fields
Kibana base URL (e.g. https://localhost:5601).Default:
null.Preview detection rule
Action ID:tools.elastic_security.preview_detection_rule
Preview alerts generated by an Elastic Security detection rule.
Reference: https://www.elastic.co/docs/api/doc/kibana/operation/operation-rulepreview
Secrets
Required secrets:elastic_security: required valuesELASTIC_API_KEY.
Input fields
Kibana base URL (e.g. https://localhost:5601).Default:
null.Enables logging and returning in response ES queries, performed during rule execution.Default:
null.Release endpoint
Action ID:tools.elastic_security.release_endpoint
Release one or more isolated Elastic Endpoints.
Reference: https://www.elastic.co/docs/api/doc/kibana/operation/operation-endpointunisolateaction
Secrets
Required secrets:elastic_security: required valuesELASTIC_API_KEY.
Input fields
API-native request body. Documented fields: endpoint_ids (required), agent_type, alert_ids, case_ids, comment.
Kibana base URL (e.g. https://localhost:5601).Default:
null.Run endpoint command
Action ID:tools.elastic_security.run_endpoint_command
Run a command on one or more Elastic Endpoints.
Reference: https://www.elastic.co/docs/api/doc/kibana/operation/operation-endpointexecuteaction
Secrets
Required secrets:elastic_security: required valuesELASTIC_API_KEY.
Input fields
API-native request body. Documented fields: command (required), endpoint_ids (required), agent_type, alert_ids, case_ids, comment, timeout.
Kibana base URL (e.g. https://localhost:5601).Default:
null.Run endpoint script
Action ID:tools.elastic_security.run_endpoint_script
Run a response script on one or more Elastic Endpoints. Requires Kibana 8.18+.
Reference: https://www.elastic.co/docs/api/doc/kibana/operation/operation-runscriptaction
Secrets
Required secrets:elastic_security: required valuesELASTIC_API_KEY.
Input fields
API-native request body. Documented fields: endpoint_ids (required), parameters (required), agent_type, alert_ids, case_ids, comment.
Kibana base URL (e.g. https://localhost:5601).Default:
null.Run Osquery live query
Action ID:tools.elastic_security.run_osquery_live_query
Run an API-native Osquery live query against Elastic Agents for host investigation.
Reference: https://www.elastic.co/docs/api/doc/kibana/operation/operation-osquerycreatelivequery
Secrets
Required secrets:elastic_security: required valuesELASTIC_API_KEY.
Input fields
Kibana base URL (e.g. https://localhost:5601).Default:
null.Scan endpoint path
Action ID:tools.elastic_security.scan_endpoint_path
Scan a file or directory on one or more Elastic Endpoints.
Reference: https://www.elastic.co/docs/api/doc/kibana/operation/operation-endpointscanaction
Secrets
Required secrets:elastic_security: required valuesELASTIC_API_KEY.
Input fields
API-native request body. Documented fields: endpoint_ids (required), path (required), agent_type, alert_ids, case_ids, comment.
Kibana base URL (e.g. https://localhost:5601).Default:
null.Search attack discoveries
Action ID:tools.elastic_security.search_attack_discoveries
Search existing Elastic Attack Discovery results using native filters and pagination. Requires Kibana 9.2+.
Reference: https://www.elastic.co/docs/api/doc/kibana/operation/operation-attackdiscoveryfind
Secrets
Required secrets:elastic_security: required valuesELASTIC_API_KEY.
Input fields
Filter results to Attack discoveries that include any of the provided alert IDs.Default:
null.Kibana base URL (e.g. https://localhost:5601).Default:
null.Filter results to Attack discoveries created by any of the provided human readable connector names. Note that values must match the human readable
connector_name property of an Attack discovery, which are distinct from connector_id values used to generate Attack discoveries.Default: null.Enables a markdown syntax used to render pivot fields. This is primarily used for Attack Discovery views within Kibana. Defaults to
false.Default: null.End of the time range for the search. Accepts absolute timestamps (ISO 8601) or relative date math (e.g. “now”, “now-24h”).Default:
null.If
true, the response will include all attack discoveries matching other criteria regardless of who created them. Mutually exclusive with shared.Default: null.If
true, the response will include unique_alert_ids and unique_alert_ids_count aggregated across the matched Attack discoveries.Default: null.Number of Attack discoveries to return per page (used for pagination). Defaults to 10.Default:
null.Whether to filter by scheduled or ad-hoc attack discoveries. If omitted, both types of attack discoveries are returned. Use
true to return only scheduled discoveries or false to return only ad-hoc discoveries.Default: null.Free-text search query applied to relevant text fields of Attack discoveries (title, description, tags, etc.).Default:
null.Whether to filter by shared visibility. If omitted, both shared and privately visible Attack discoveries are returned. Use
true to return only shared discoveries, false to return only those visible to the current user. Mutually exclusive with include_all_authors.Default: null.Field used to sort results. Possible values: @timestamp. Defaults to @timestamp.Default:
null.Sort order direction,
asc for ascending or desc for descending. Possible values: asc, desc. Defaults to desc.Default: null.Start of the time range for the search. Accepts absolute timestamps (ISO 8601) or relative date math (e.g. “now-7d”).Default:
null.Filter by alert workflow status. Provide one or more of the allowed workflow states. Possible values: acknowledged, closed, open.Default:
null.When true, return the created Attack discoveries with text replacements applied to the detailsMarkdown, entitySummaryMarkdown, summaryMarkdown, and title fields. Defaults to
true.Default: null.Search attacks
Action ID:tools.elastic_security.search_attacks
Find and/or aggregate Attack Discovery attack alerts with Elasticsearch Query DSL. Requires Kibana 9.5+.
Reference: https://www.elastic.co/docs/api/doc/kibana/operation/operation-searchattacks
Secrets
Required secrets:elastic_security: required valuesELASTIC_API_KEY.
Input fields
API-native JSON request body. Optional
query, aggs, size, sort, _source, fields, runtime_mappings, track_total_hits.Kibana base URL (e.g. https://localhost:5601).Default:
null.Search detection alerts
Action ID:tools.elastic_security.search_detection_alerts
Find or aggregate Elastic Security detection alerts using the API-native search body.
Reference: https://www.elastic.co/docs/api/doc/kibana/operation/operation-searchalerts
Secrets
Required secrets:elastic_security: required valuesELASTIC_API_KEY.
Input fields
Kibana base URL (e.g. https://localhost:5601).Default:
null.Search entities
Action ID:tools.elastic_security.search_entities
Search Elastic Entity Store records for investigation context, including entity risk and asset data. On Kibana 8.18 to 9.3, set use_legacy_endpoint to true.
Reference: https://www.elastic.co/docs/api/doc/kibana/operation/operation-get-security-entity-store-entities
Secrets
Required secrets:elastic_security: required valuesELASTIC_API_KEY.
Input fields
Kibana base URL (e.g. https://localhost:5601).Default:
null.Entity types to include in the results. Possible values: user, host, service, generic.Default:
null.Set to true on Kibana 8.18 to 9.3, which serve this list at GET /api/entity_store/entities/list (Kibana 9.4+ uses /api/security/entity_store/entities; legacy docs: https://www.elastic.co/docs/api/doc/kibana/v8/operation/operation-listentities). The legacy endpoint requires
entity_types and only accepts sort_field, sort_order, page, per_page, and filterQuery.Default: false.Set attack status
Action ID:tools.elastic_security.set_attack_status
Set the workflow status of Attack Discovery attack alerts. Requires Kibana 9.5+.
Reference: https://www.elastic.co/docs/api/doc/kibana/operation/operation-setattacksstatus
Secrets
Required secrets:elastic_security: required valuesELASTIC_API_KEY.
Input fields
API-native JSON request body. Requires
ids and status (open, acknowledged, in-progress, or closed); optional update_related_alerts, and reason when closing.Kibana base URL (e.g. https://localhost:5601).Default:
null.Set detection alert status
Action ID:tools.elastic_security.set_detection_alert_status
Set the status of Elastic Security detection alerts.
Reference: https://www.elastic.co/docs/api/doc/kibana/operation/operation-setalertsstatus
Secrets
Required secrets:elastic_security: required valuesELASTIC_API_KEY.
Input fields
Kibana base URL (e.g. https://localhost:5601).Default:
null.Suspend endpoint process
Action ID:tools.elastic_security.suspend_endpoint_process
Suspend a process on one or more Elastic Endpoints.
Reference: https://www.elastic.co/docs/api/doc/kibana/operation/operation-endpointsuspendprocessaction
Secrets
Required secrets:elastic_security: required valuesELASTIC_API_KEY.
Input fields
API-native request body. Documented fields: endpoint_ids (required), parameters (required), agent_type, alert_ids, case_ids, comment.
Kibana base URL (e.g. https://localhost:5601).Default:
null.Terminate endpoint process
Action ID:tools.elastic_security.terminate_endpoint_process
Terminate a process on one or more Elastic Endpoints.
Reference: https://www.elastic.co/docs/api/doc/kibana/operation/operation-endpointkillprocessaction
Secrets
Required secrets:elastic_security: required valuesELASTIC_API_KEY.
Input fields
API-native request body. Documented fields: endpoint_ids (required), parameters (required), agent_type, alert_ids, case_ids, comment.
Kibana base URL (e.g. https://localhost:5601).Default:
null.Update attack tags
Action ID:tools.elastic_security.update_attack_tags
Add or remove tags on Attack Discovery attack alerts. Requires Kibana 9.5+.
Reference: https://www.elastic.co/docs/api/doc/kibana/operation/operation-setattackstags
Secrets
Required secrets:elastic_security: required valuesELASTIC_API_KEY.
Input fields
Kibana base URL (e.g. https://localhost:5601).Default:
null.When
true, the change is also applied to detection alerts related to the attacks.Default: false.Update detection alert tags
Action ID:tools.elastic_security.update_detection_alert_tags
Add or remove tags on Elastic Security detection alerts.
Reference: https://www.elastic.co/docs/api/doc/kibana/operation/operation-setalerttags
Secrets
Required secrets:elastic_security: required valuesELASTIC_API_KEY.
Input fields
Object with list of tags to add and remove. Requires
tags_to_add and tags_to_remove, each a list of keywords to organize related alerts into categories that you can filter and group.Kibana base URL (e.g. https://localhost:5601).Default:
null.Upload endpoint file
Action ID:tools.elastic_security.upload_endpoint_file
Upload a file to one or more Elastic Endpoints.
Reference: https://www.elastic.co/docs/api/doc/kibana/operation/operation-endpointuploadaction
Secrets
Required secrets:elastic_security: required valuesELASTIC_API_KEY.
Input fields
Kibana base URL (e.g. https://localhost:5601).Default:
null.