Send instructions to an agent

Creates an instruction for an individual Tenable Agent to perform. Instructions include restarting the agent or changing its local product settings. To send the same instruction to multiple agents in one request, use the Send instructions to agents endpoint. To send instructions to every agent in an agent group, use the Send instructions to agents group endpoint.

Note: Only one restart instruction can be in progress for an agent at a time. Sending a second restart instruction while one is in progress returns a 409 response.

Note: An instruction that requests the agent's debug logs requires only the Can Use [16] agent group permission. Every other instruction type, including a settings instruction that changes backend_log_level, requires Can Manage [64].

Requires the Scan Manager [40] user role. Alternatively, requires the VM.VM_SENSOR.VM_AGENT.EDIT custom role privilege and the Can Manage [64] agent group permission on a group that contains the agent. See Roles and Permissions.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required

Specifies the ID of the agent to send the instruction to.

Body Params
string
enum
required

Specifies the type of instruction to send. To restart the agent, the type is always restart.

Allowed:
options
object

Specifies the options for the restart operation.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json