NEnetxms
Object Tools

Get object tool details

Changed on

Retrieve full details of a specific object tool. When the caller has SYSTEM_ACCESS_MANAGE_TOOLS rights the response additionally includes the acl and (for snmp-table / agent-list tools) columns fields.

get/v1/object-tools/{tool-id}

Request

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

Path parameters

tool-idinteger required

Object tool ID

Response

Successful retrieval of object tool details.

idinteger

Tool ID

namestring

Tool name

type'action' | 'snmp-table' | 'agent-list' | 'url' | 'command' | 'server-command' | 'file-download' | 'server-script' | 'agent-table' | 'ssh-command'

Type of object tool

confirmationMessagestring

Confirmation message shown to user

commandNamestring

Full command name

commandShortNamestring

Short command name

remotePortinteger

Remote port for TCP tunnel

remoteHoststring

Remote host for TCP tunnel

applicableClassesinteger

Bitmask of object classes the tool is applicable to. Bit 0 (1) = Node, bit 1 (2) = Interface, bit 2 (4) = Sensor, bit 3 (8) = Access point. Only server-script and URL tools may include bits other than Node.

datastring

Tool-specific data

descriptionstring

Tool description

filterstring

Tool filter (matching OID for SNMP tools)

iconstring uuid

UUID of the icon image in the image library; absent when no icon is set

aclinteger[]

User and group IDs allowed to execute this tool. Only present when the caller has SYSTEM_ACCESS_MANAGE_TOOLS rights.

Changes

  • 69bf641bba09Revision changes
    • info

      removed the internal enum value from the //// response property for the response status

  • 30e75dc6a94cRevision changes
    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • info

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

    • info

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

    • info

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

    • info

      added the optional property / to the response with the status