Issue a command to a device

Force a device to Scan, Patch, or Reboot for immediate execution. Note: The installAllUpdates option ignores any Policy Filters. Please use /policies/{id}/action to run a policy immediately. See Using Global API Keys for more information on permission and scope requirements.

SecuritybearerAuth
Request
path Parameters
id
required
integer <int64>

Server ID for the specified device

query Parameters
o
required
integer <int64>

Organization ID for the specified device

Request Body schema: application/json
required
command_type_name
required
string
Enum Value Description
GetOS

Triggers a device scan.

InstallUpdate

Installs a specific patch.

InstallAllUpdates

Installs all available patches. NOTE: This ignores any Policy Filters!

Reboot

Forces a reboot.

args
string

Only needed for InstallUpdate. Includes the name of the patches to install.

Responses
201

Command submitted successfully

401

Access token is missing or invalid

403

You do not have permission to perform this action.

429

Too many requests

503

Service Unavailable

default

Invalid Request

post/servers/{id}/queues
Request samples
application/json
{
  • "summary": "Issue command request example",
  • "description": "Example request for issuing a command to devices",
  • "value": {
    • "command_type_name": "GetOS",
    • "args": ""
    }
}
Response samples
application/json
{
  • "errors": [
    • "string"
    ]
}