Send instructions to agents group

post

https://cloud.tenable.com/scanners/null/agent-groups/{group_id}/agents/_bulk/directive

Create instructions for agents in an agent group to perform. Instructions include restarting or changing local product settings. To send an instruction to a single agent, use the Send instructions to an agent endpoint. To send instructions to a set of agents rather than a group, use the Send instructions to agents endpoint.

Requires the Scan Manager [40] user role. See Roles.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

group_id

int32

required

The ID or UUID of the agent group.

Body Params

criteria

object

Specifies the criteria you wish to filter agents on. The criteria is used to narrow down the list of agents to perform the specified action on.

items

array

An array of agent IDs or agent UUIDs to add to the criteria filter.

items

not_items

array

An array of agent IDs or agent UUIDs to exclude from the criteria filter.

not_items

directive

Specifies the instructions you wish to send to the agents. The directive object is different depending on whether you want to restart the agents or change settings for the agents.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

403

Returned if you do not have permission to create or interact with a bulk operation task.

404

Returned if Tenable Vulnerability Management could not find the specified agent or agent group.

Language

Credentials

Header

Loading…

Response

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

application/json

text/html

200Returned if Tenable Vulnerability Management successfully created the bulk operation task.

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

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.