v51

latestOpenAPI 3.0.2raw.githubusercontent.com2026-08-01245104440.0 KB

Objects

Get node SNMP communication configuration

Return the node's SNMP communication settings (the same shape accepted by the matching PATCH). Credential passwords (authPassword, privPassword, and their trap counterparts) are included only when the caller has modify or read-credentials access to the object.

This property group applies to Node objects only; requesting it for any other object class returns 400.

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

Path parameters

object-idinteger required

Response

SNMP communication configuration.

version'1' | '2c' | '3' | 'default'

SNMP protocol version used for polling. Clamped up to the server minimum SNMP version.

portinteger

SNMP UDP port.

proxyinteger nullable

ID of the node used as SNMP proxy, or 0 for no proxy.

codepagestring nullable

Codepage used to decode SNMP string values (empty for server default).

settingsLockedboolean

Prevent automatic SNMP configuration changes by configuration polls.

authNamestring nullable

Community string for SNMP v1/v2c, or USM user name for SNMP v3.

authMethod'NONE' | 'MD5' | 'SHA1' | 'SHA224' | 'SHA256' | 'SHA384' | 'SHA512'

SNMP v3 authentication method.

authPasswordstring nullable

SNMP v3 authentication password (write-only).

privMethod'NONE' | 'DES' | 'AES-128' | 'AES-192' | 'AES-256'

SNMP v3 privacy (encryption) method.

privPasswordstring nullable

SNMP v3 privacy password (write-only).

contextNamestring nullable

SNMP v3 context name.