v51

OpenAPI 3.0.2raw.githubusercontent.com2026-08-01245104440.0 KB

Object Tools

Execute an object tool

Execute a server-capable object tool on the specified object. Supported tool types: action (agent action), server-command, server-script, snmp-table, agent-table, agent-list, ssh-command, url. Client-only tool types (internal, command, file-download) are rejected with 400.

post/v1/object-tools/{tool-id}/execute

Path parameters

tool-idinteger required

Object tool ID

Request body

objectIdinteger required

ID of the target object to execute the tool on

alarmIdinteger

Optional alarm ID for macro expansion context

inputFieldsobject

Optional input field values for macro expansion

maskedFieldsstring[]

Optional list of input field names whose values must be masked in the audit log and in user-visible context such as the result table title for table tools (typically password-type fields). Names not present in inputFields are ignored.

streamboolean

If true and the tool generates output, execution starts asynchronously and a WebSocket token is returned for streaming output. Supported for tool types: action, server-command, server-script, ssh-command.

Response

Tool executed successfully (synchronous mode)