AI Chat7

AI Management3

AI Operators14

AI Saved Prompts5

Alarm Categories5

Alarms10

Asset Management Schema5

Authentication2

Background Tasks1

Chat Bots7

Cloud Connectors1

Data Collection10

DCI Summary Tables7

Event Forwarders7

Event Processing Policy8

Event Templates5

Find2

Geo Areas5

Grafana8

Image Library6

Incidents10

Log Parsers2

Logs5

Notification Channels9

Object Categories5

Object Tools10

Objects83

Scheduled Tasks6

Script Library6

Server8

Server Actions5

SNMP MIB2

SSH Keys5

TCP Proxy2

Traffic Observers1

Two-Factor Authentication9

User Groups5

Users9

Web Service Definitions5

Object Tools

Get object tool details

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}

Path parameters

tool-idinteger required

Object tool ID

Response

Successful retrieval of object tool details.

idinteger

Tool ID

namestring

Tool name

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

Changed in 4 of the 115 revisions of this API.189

Aug 5, 202669bf641bba091See the full diff
- ○
  removed the internal enum value from the //// response property for the response status
  response-property-enum-value-removed
Jun 10, 202630e75dc6a94c24See the full diff
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
- ○
  added the optional property //// to the response with the status
  response-optional-property-added
- ○
  added the optional property //// to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
May 18, 20265a88701fa0883See the full diff
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
May 8, 2026c6aaf3632e48161See the full diff
- ▲
  the / response's property format changed from uuid to no format for status
  response-property-type-changed
- ●
  removed the optional property ////// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property //// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property //// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ○
  added the optional property / to the response with the status
  response-optional-property-added
This revision also has 40 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history