NEnetxms
Object Tools

List object tools applicable to an object

Changed on

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).

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

Request

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

Path parameters

object-idinteger required

Object ID to filter tools for

Query parameters

typesstring

Comma-separated list of tool types to filter by. Uses kebab-case format (e.g., "action,server-script,ssh-command")

Response

Successful retrieval of applicable object tools.

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.

Changes

  • 69bf641bba09Revision changes
    • info

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

  • 30e75dc6a94cRevision changes
    • 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