Run a script
https://{kibana_url}
- POST /api/endpoint/action/run_script
Run a script on a host. Currently supported only for some agent types.
Request
-
agent_type -
List of agent types to retrieve. Defaults to
endpoint. -
Values:
endpointsentinel_onecrowdstrikemicrosoft_defender_endpoint -
alert_idsstring · min: 1 · max: 50 -
If this action is associated with any alerts, they can be specified here. The action will be logged in any cases associated with the specified alerts. Max of 50.
-
case_idsstring · min: 1 · max: 50 -
The IDs of cases where the action taken will be logged. Max of 50.
-
commentstring · max: 30000 -
Optional comment
-
endpoint_idsobject · min: 1 · max: 250required -
List of endpoint IDs (cannot contain empty strings). Max of 250.
-
parametersobjectrequired -
Parameters object
Response
Indicates a successful call.
-
data -
agentsstring -
The agent IDs for the hosts that the response action was sent to
-
agentStatemap string to object -
The state of the response action for each agent ID that it was sent to
-
<string>object -
completedAtstring -
The date and time the response action was completed for the agent ID
-
isCompletedboolean -
Whether the response action is completed for the agent ID
-
wasCanceledboolean -
Whether the response action was canceled for the agent ID
-
wasSuccessfulboolean -
Whether the response action was successful for the agent ID
-
agentType -
List of agent types to retrieve. Defaults to
endpoint. -
Values:
endpointsentinel_onecrowdstrikemicrosoft_defender_endpoint -
command· min: 1required -
The command for the response action
-
Values:
isolateunisolatekill-processsuspend-processrunning-processesget-fileexecuteuploadscanrunscriptcancelmemory-dump -
completedAtstring -
The response action completion time
-
createdBystring -
The user who created the response action
-
hostsmap string to object -
An object containing the host names associated with the agent IDs the response action was sent to
-
<string>object -
namestring -
The host name
-
idstring -
The response action ID
-
isCompleteboolean -
Whether the response action is complete
-
isExpiredboolean -
Whether the response action is expired
-
outputsmap string to object -
The outputs of the response action for each agent ID that it was sent to. Content different depending on the response action command and will only be present for agents that have responded to the response action
-
parametersobject -
The parameters of the response action. Content different depending on the response action command
-
startedAtstring -
The response action start time
-
statusstring -
The response action status
-
wasCanceledboolean -
Whether the response action was canceled
-
wasSuccessfulboolean -
Whether the response action was successful