NEnetxms
Object Tools

Execute an object tool

Changed on

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 (command, file-download) are rejected with 400.

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

Request

  • Base URL
    http://127.0.0.1:8000
  • URL
    http://127.0.0.1:8000/v1/object-tools/{tool-id}/execute
  • Auth
    HTTP bearer

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)

OR
OR
OR

Changes

  • ea6f0284e9b6Revision changes
    • breaking

      the /////// response's property type changed from integer to string for status

    • warning

      removed the optional property ///// from the response with the status

    • warning

      added the new counter32 enum value to the /////// response property for the response status

    • warning

      added the new counter64 enum value to the /////// response property for the response status

    • warning

      added the new float enum value to the /////// response property for the response status

    • warning

      added the new int32 enum value to the /////// response property for the response status

    • warning

      added the new int64 enum value to the /////// response property for the response status

    • warning

      added the new null enum value to the /////// response property for the response status

    • warning

      added the new string enum value to the /////// response property for the response status

    • warning

      added the new uint32 enum value to the /////// response property for the response status

    • warning

      added the new uint64 enum value to the /////// response property for the response status

    • info

      added the optional property ///// to the response with the status

  • 37e78a603eb9Revision changes
    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status