---
title: "List object tools applicable to an object"
method: GET
path: "/v1/objects/{object-id}/object-tools"
tags: ["Object Tools"]
---

# List object tools applicable to an object

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

Retrieve a list of object tools that are applicable to the specified object, filtered by tool ACL, container context, disabled status, and the tool's menu filter (SNMP/agent requirements, OID match, OS match, template match, custom attribute match).

## Path parameters

- `object-id` integer, required

## Query parameters

- `types` string

## Response `200`

Successful retrieval of applicable object tools.

- ObjectToolSummary[]
  - `id` integer — Tool ID
  - `name` string — Tool name
  - `type` '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
  - `remotePort` integer — Remote port for TCP tunnel
  - `remoteHost` string — Remote host for TCP tunnel
  - `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
    - `defaultValue` string — Default value for the field
    - `flags` integer — Field flags
    - `sequence` integer — Field sequence order

## Other responses

- `400` — Invalid object ID.
- `403` — User does not have read access to the object.
- `404` — Object with given ID does not exist.
- `500` — Database failure.

---

[API](https://skmtc.net/netxms/apis/netxms-api.md) · [All operations](https://skmtc.net/netxms/apis/netxms-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/netxms/netxms-api/versions/14d93e5115dd/schema)