/agents/reset
POST
Resets Agents
Any currently running orders are continued. Workflows and other deployable objects are withdrawn. The Agents drop its journal and restart. Then the Controller tries to reconnect to the Agents, deploys workflows etc. and submits orders to the Agents.
Parameters in the POST body schema
Name | Type | Description | Example | Default |
---|---|---|---|---|
controllerId |
required, string | Controller ID | myController | |
agentIds |
required, array[string] | Specifies Agent IDs | ||
force |
optional, boolean | With force = true the Agent is reset, even if
|
false | |
auditLog |
optional, object | Object that contains comment , timeSpent and ticketLink . |
{ "comment": "Operational requirement!", "timeSpent": 2 } |
|
comment |
optional, string | Field in auditLog to comment this action, e.g. the reason. |
||
timeSpent |
optional, integer | Field in auditLog to enter the time spent in minutes. |
||
ticketLink |
optional, string | Field in auditLog to enter a link to a corresponding ticket. |
Request