---
title: "Get node SNMP communication configuration"
method: GET
path: "/v1/objects/{object-id}/snmp"
tags: ["Objects"]
---

# Get node SNMP communication configuration

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

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.

## Path parameters

- `object-id` integer, required

## Response `200`

SNMP communication configuration.

- SnmpConfig — SNMP communication property group for a node. Returned by GET /v1/objects/{id}/snmp and embedded as `ObjectDetails.snmp`; accepted by PATCH /v1/objects/{id}/snmp with merge-patch semantics (omitted fields are left unchanged).
  - `version` '1' | '2c' | '3' | 'default' — SNMP protocol version used for polling. Clamped up to the server minimum SNMP version.
  - `port` integer — SNMP UDP port.
  - `proxy` integer, nullable — ID of the node used as SNMP proxy, or 0 for no proxy.
  - `codepage` string, nullable — Codepage used to decode SNMP string values (empty for server default).
  - `settingsLocked` boolean — Prevent automatic SNMP configuration changes by configuration polls.
  - `authName` string, 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.
  - `authPassword` string, nullable — SNMP v3 authentication password (write-only).
  - `privMethod` 'NONE' | 'DES' | 'AES-128' | 'AES-192' | 'AES-256' — SNMP v3 privacy (encryption) method.
  - `privPassword` string, nullable — SNMP v3 privacy password (write-only).
  - `contextName` string, nullable — SNMP v3 context name.
  - `trap` SnmpTrapCredentials — Separate SNMP trap reception credentials. Merge-patched onto the existing trap credentials; omitted fields are left unchanged. When the trap credentials are being created (none existed before) the version defaults to 2c.
    - `version` '1' | '2c' | '3' — SNMP version of the expected traps.
    - `authName` string — Trap community string (v1/v2c) or USM user name (v3).
    - `authMethod` 'NONE' | 'MD5' | 'SHA1' | 'SHA224' | 'SHA256' | 'SHA384' | 'SHA512' — SNMP v3 authentication method for traps.
    - `authPassword` string, nullable — SNMP v3 trap authentication password (write-only).
    - `privMethod` 'NONE' | 'DES' | 'AES-128' | 'AES-192' | 'AES-256' — SNMP v3 privacy method for traps.
    - `privPassword` string, nullable — SNMP v3 trap privacy password (write-only).
  - `agents` SnmpAgentConfig[] — Additional SNMP agents configured on the node, referenced by name from data collection items. On PATCH the array fully replaces the existing list (it is not merged element-wise); agent names must be unique within the node.
    - `name` string, required — Agent name, unique within the node. Referenced from data collection items.
    - `address` string, nullable — IP address of the agent, or null to use the node's primary IP address.
    - `port` integer — SNMP UDP port (defaults to 161 when omitted on creation).
    - `version` '1' | '2c' | '3', required — SNMP protocol version.
    - `authName` string, 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.
    - `authPassword` string, nullable — SNMP v3 authentication password (returned only with credential access).
    - `privMethod` 'NONE' | 'DES' | 'AES-128' | 'AES-192' | 'AES-256' — SNMP v3 privacy (encryption) method.
    - `privPassword` string, nullable — SNMP v3 privacy password (returned only with credential access).
    - `contextName` string, nullable — SNMP context name.

## Other responses

- `400` — Property group not applicable to object class.
- `401` — Unauthorized
- `403` — User does not have read access to the object
- `404` — Object with given ID does not exist

---

[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/revisions/f9d69e142034/schema)