Sign in
Object Tools

List available object tools

Retrieve a list of object tools with basic information.

get/v1/object-tools

Query parameters

typesstring

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

Response

Successful retrieval of object tools.

idinteger

Tool ID

namestring

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

confirmationMessagestring

Confirmation message shown to user

commandNamestring

Full command name

commandShortNamestring

Short command name

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