---
title: "Get object tool details"
method: GET
path: "/v1/object-tools/{tool-id}"
tags: ["Object Tools"]
---

# Get object tool details

`GET /v1/object-tools/{tool-id}`

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.

## Path parameters

- `tool-id` integer, required

## Response `200`

Successful retrieval of object tool details.

- ObjectToolDetails
  - `id` integer — Tool ID
  - `name` string — Tool name
  - `type` 'internal' | 'action' | 'snmp-table' | 'agent-list' | 'url' | 'command' | 'server-command' | 'file-download' | 'server-script' | 'agent-table' | 'ssh-command' — Type of object tool
  - `flags` object — Tool flags
    - `askConfirmation` boolean — Whether to ask for user confirmation before execution
    - `generatesOutput` boolean — Whether the tool generates output
    - `disabled` boolean — Whether the tool is disabled
    - `showInCommands` boolean — Whether to show in commands menu
    - `snmpIndexedByValue` boolean — Whether SNMP is indexed by value
    - `runInContainerContext` boolean — Whether to run in container context
    - `suppressSuccessMessage` boolean — Whether to suppress success message
    - `setupTcpTunnel` boolean — Whether to setup TCP tunnel
  - `confirmationMessage` string — Confirmation message shown to user
  - `commandName` string — Full command name
  - `commandShortName` string — Short command name
  - `applicableClasses` integer — 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.
  - `inputFields` ObjectToolInputField[] — Input field definitions
    - `name` string — Field name
    - `type` integer — Field type
    - `displayName` string — Display name for the field
    - `flags` integer — Field flags
    - `sequence` integer — Field sequence order
  - `data` string — Tool-specific data
  - `description` string — Tool description
  - `filter` string — Tool filter (matching OID for SNMP tools)
  - `icon` string, uuid — UUID of the icon image in the image library; absent when no icon is set
  - `remotePort` integer — Remote port for TCP tunnel
  - `remoteHost` string — Remote host for TCP tunnel
  - `acl` integer[] — User and group IDs allowed to execute this tool. Only present when the caller has SYSTEM_ACCESS_MANAGE_TOOLS rights.
  - `columns` ObjectToolColumn[] — Column definitions for table tools. Only present when the caller has SYSTEM_ACCESS_MANAGE_TOOLS rights and the tool type is snmp-table or agent-list.
    - `name` string — Column display name
    - `oid` string — Column SNMP OID or agent column expression
    - `format` integer — Column data format code
    - `captureGroup` integer — Regex capture group number used to extract the cell value (0 for whole match)

## Other responses

- `400` — Invalid tool ID.
- `403` — Access denied.
- `404` — Tool not found.
- `500` — Database failure.

## Changes

- **2026-05-18** `5a88701fa088` — 3 info
  - added the optional property `allOf[subschema #2]/acl` to the response with the `200` status
  - added the optional property `allOf[subschema #2]/columns` to the response with the `200` status
  - added the optional property `allOf[subschema #2]/remoteHost` to the response with the `200` status
- **2026-05-08** `c6aaf3632e48` — 1 breaking, 6 warning, 1 info
  - the `allOf[subschema #2]/icon` response's property format changed from `uuid` to no format for status `200`
  - removed the optional property `allOf[#/components/schemas/ObjectToolSummary]/inputFields/items/defaultValue` from the response with the `200` status
  - removed the optional property `allOf[#/components/schemas/ObjectToolSummary]/remoteHost` from the response with the `200` status
  - removed the optional property `allOf[#/components/schemas/ObjectToolSummary]/remotePort` from the response with the `200` status
  - …4 more

[Change history](https://skmtc.dev/netxms/apis/netxms-api/changes/v1/object-tools/:tool-id/get.md)

---

[API](https://skmtc.dev/netxms/apis/netxms-api.md) · [All operations](https://skmtc.dev/netxms/apis/netxms-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/netxms/netxms-api/revisions/ae5cc12f63ac/schema)