Send instructions to an agent

post

https://cloud.tenable.com/scanners/null/agents/{agent_id}/directives

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.

Requires the Scan Manager [40] user role or the VM.VM_SENSOR.VM_AGENT.EDIT custom role privilege. See Roles.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Returned if the instruction was created successfully.

400Returned if your request specified an unsupported instruction type, or if a settings instruction did not specify any settings.

401Returned if the API keys specified in your request are invalid.

403Returned if you do not have permission to send instructions to agents.

404Returned if Tenable Vulnerability Management cannot find the specified agent.

409Returned if a restart instruction is already in progress for the specified agent.

429Returned if you attempt to send too many requests in a specific period of time. For more information, see Rate Limiting.

500Returned if an internal error occurred.