Dispatch a response action to an agent device

post/org/agents/devices/{device_id}/actions

Request

  • Base URL: https://api.blumira.com/public-api/v1
  • URL: https://api.blumira.com/public-api/v1/org/agents/devices/{device_id}/actions
  • Auth: HTTP bearer

Path parameters

device_idstring uuid required

Device ID of the object, e.g., "00110011-0000-0000-0000-000000000000"

Headers

Authorizationstring required

Bearer followed by JWT, e.g., "Bearer eyJh...enA"

Request body

action'isolate' | 'deisolate' | 'kill_process' | 'kill_process_tree' | 'delete_file' | 'disable_local_user' | 'disable_ad_user' required

Response action to dispatch (e.g. isolate, deisolate)

idempotency_keystring required

Caller-supplied key for deduplicating repeated dispatch requests

parametersobject

Action-specific parameters

window_secondsinteger

Optional. Seconds until the command is considered timed out if not yet terminal. Defaults to 300 when omitted.

Response

Idempotent replay of a previously-dispatched command

actionstring required

Response action that was dispatched

command_idstring uuid required

UUID of the command

device_idstring uuid required

UUID of the agent device the command targets

dispatched_atstring date-time required

When the command was dispatched

resultobject nullable

Action-specific terminal result; null until the command reaches a terminal status. Task actions: {exit_code, reason?}. isolate/deisolate: {is_isolated}. Fan-out (parent commands): {children: [{device_id, status, exit_code?, error?}]}.

status'accepted' | 'running' | 'succeeded' | 'failed' | 'timed_out' | 'dispatch_failed' required

Current lifecycle status of the command

terminal_atstring date-time nullable

When the command reached a terminal status; null until then

Changes

No recorded changes to this operation across all 1 revision of this API.