v1

latestOpenAPI 3.1.02026-07-22106199311.5 KB
Agents

Trigger an Agent command

The command to be triggered.

Available commands are:

  • RESTART - Restart the Agent.
  • PAUSE - Set the Agent to 'Paused'.
  • RESUME - Un-sets a 'Paused' agent.
post/v1/agents/{agentId}/commands

Path parameters

agentIdstring required

Request body

command'RESTART' | 'PAUSE' | 'RESUME' required

The command being sent

Example request

{
  "command": "RESTART"
}

Response

Agent command received successfully