Objects

Execute command on agent

post/v1/objects/{object-id}/execute-agent-command

Path parameters

object-idinteger required

commandstring required

Command line to execute. Supports macro expansion; the command name is the first token, remaining tokens are passed as arguments.

alarmIdinteger

Optional alarm ID used as context for macro expansion. Requires read access to the alarm.

inputFieldsobject

Optional map of input field values used for macro expansion.

Command executed successfully

Changed in 2 of the 115 revisions of this API.2

Jun 10, 202630e75dc6a94c1See the full diff
- ▲
  added required request body
  request-body-added-required
May 8, 2026c6aaf3632e481See the full diff
- ▲
  removed the request body
  request-body-removed
This revision also has 40 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog