SNMP Connection - Apinizer Dokümantasyonu

General Information

Connection Type

snmp

UI Documentation

Endpoints

List Connections

GET /apiops/projects/{projectName}/connections/?type=snmp

Get Connection

GET /apiops/projects/{projectName}/connections/{connectionName}/

Create Connection

POST /apiops/projects/{projectName}/connections/{connectionName}/

Update Connection

PUT /apiops/projects/{projectName}/connections/{connectionName}/

Delete Connection

DELETE /apiops/projects/{projectName}/connections/{connectionName}/

List Connections

Endpoint

GET /apiops/projects/{projectName}/connections/?type=snmp

Request

Headers

Header	Value
Authorization	Bearer

Path Parameters

Parameter	Type	Required	Description
projectName	string	Yes	Project name

Note: The type query parameter is required to filter connections by type.

cURL Example

curl -X GET \
  "https://demo.apinizer.com/apiops/projects/MyProject/connections/" \
  -H "Authorization: Bearer YOUR_TOKEN"

Get Connection

Endpoint

GET /apiops/projects/{projectName}/connections/{connectionName}/

Request

Headers

Header	Value
Authorization	Bearer

Path Parameters

Parameter	Type	Required	Description
projectName	string	Yes	Project name
connectionName	string	Yes	Connection name

Response

Success Response (200 OK)

{
  "success": true,
  "resultList": [
    {
      "type": "snmp",
      "name": "my-snmp-connection",
      "description": "SNMP connection for traps",
      "deployToWorker": true,
      "enabled": true,
      "version": "V1",
      "connectionString": "udp:192.168.1.2/162",
      "securityOrCommunityName": "public",
      "retryCount": 3,
      "timeout": 5000,
      "messageType": "TRAP",
      "securityLevel": null,
      "privacyProtocolList": [],
      "enableUserAuthentication": false,
      "securityName": null,
      "usmUserAuthenticationProtocol": null,
      "authPassphrase": null,
      "usmUserPrivacyProtocol": null,
      "privPassphrase": null,
      "pduOidForMessage": "1.3.6.1.4.1.12345.1.1",
      "pduOidForTime": "1.3.6.1.4.1.12345.1.2",
      "pduVariableMap": {
        "1.3.6.1.4.1.12345.1.3": "value1"
      }
    }
  ],
  "resultCount": 1
}

Note: Passphrases are masked in get operations.

cURL Example

curl -X GET \
  "https://demo.apinizer.com/apiops/projects/MyProject/connections/my-snmp-connection/" \
  -H "Authorization: Bearer YOUR_TOKEN"

Create Connection

Endpoint

POST /apiops/projects/{projectName}/connections/{connectionName}/

Request

Headers

Header	Value
Authorization	Bearer
Content-Type	application/json

Path Parameters

Parameter	Type	Required	Description
projectName	string	Yes	Project name
connectionName	string	Yes	Connection name

Request Body

Full JSON Body Example - SNMP v1 Trap

{
  "type": "snmp",
  "name": "my-snmp-connection",
  "description": "SNMP connection for traps",
  "deployToWorker": true,
  "enabled": true,
  "version": "V1",
  "connectionString": "udp:192.168.1.2/162",
  "securityOrCommunityName": "public",
  "retryCount": 3,
  "timeout": 5000,
  "messageType": "TRAP",
  "securityLevel": null,
  "privacyProtocolList": [],
  "enabledUserAuthentication": false,
  "securityName": null,
  "usmUserAuthenticationProtocol": null,
  "authPassphrase": null,
  "usmUserPrivacyProtocol": null,
  "privPassphrase": null,
  "pduUdpForMessage": "1.3.6.1.4.1.12345.1.1",
  "pduUdpForTime": "1.3.6.1.4.1.12345.1.2",
  "pduVariableMap": {
    "1.3.6.1.4.1.12345.1.3": "value1"
  }
}

Full JSON Body Example - SNMP v2c Inform

{
  "type": "snmp",
  "name": "my-snmp-v2c",
  "description": "SNMP v2c inform connection",
  "deployToWorker": true,
  "enabled": true,
  "version": "V2c",
  "connectionString": "udp:192.168.1.2/162",
  "securityOrCommunityName": "public",
  "retryCount": 3,
  "timeout": 5000,
  "messageType": "INFORM",
  "securityLevel": null,
  "privacyProtocolList": [],
  "enableUserAuthentication": false,
  "securityName": null,
  "usmUserAuthenticationProtocol": null,
  "authPassphrase": null,
  "usmUserPrivacyProtocol": null,
  "privPassphrase": null,
  "pduOidForMessage": "1.3.6.1.4.1.12345.1.1",
  "pduOidForTime": "1.3.6.1.4.1.12345.1.2",
  "pduVariableMap": {
    "1.3.6.1.4.1.12345.1.3": "value1"
  }
}

Full JSON Body Example - SNMP v3 with Authentication and Privacy

{
  "type": "snmp",
  "name": "my-snmp-v3-secure",
  "description": "SNMP v3 with authentication and privacy",
  "deployToWorker": true,
  "enabled": true,
  "version": "V3",
  "connectionString": "udp:192.168.1.2/162",
  "securityOrCommunityName": "securityUser",
  "retryCount": 3,
  "timeout": 5000,
  "messageType": "TRAP",
  "securityLevel": "AUTH_PRIV",
  "privacyProtocolList": [
    "PrivAES128",
    "PrivAES256"
  ],
  "enableUserAuthentication": true,
  "securityName": "securityUser",
  "usmUserAuthenticationProtocol": "AuthSHA",
  "authPassphrase": "authPassword123",
  "usmUserPrivacyProtocol": "PrivAES128",
  "privPassphrase": "privPassword123",
  "pduOidForMessage": "1.3.6.1.4.1.12345.1.1",
  "pduOidForTime": "1.3.6.1.4.1.12345.1.2",
  "pduVariableMap": {
    "1.3.6.1.4.1.12345.1.3": "value1"
  }
}

Full JSON Body Example - SNMP v3 with Authentication Only

{
  "type": "snmp",
  "name": "my-snmp-v3-auth",
  "description": "SNMP v3 with authentication only",
  "deployToWorker": true,
  "enabled": true,
  "version": "V3",
  "connectionString": "udp:192.168.1.2/162",
  "securityOrCommunityName": "securityUser",
  "retryCount": 3,
  "timeout": 5000,
  "messageType": "INFORM",
  "securityLevel": "AUTH_NOPRIV",
  "privacyProtocolList": [],
  "enableUserAuthentication": true,
  "securityName": "securityUser",
  "usmUserAuthenticationProtocol": "AuthMD5",
  "authPassphrase": "authPassword123",
  "usmUserPrivacyProtocol": null,
  "privPassphrase": null,
  "pduOidForMessage": "1.3.6.1.4.1.12345.1.1",
  "pduOidForTime": "1.3.6.1.4.1.12345.1.2",
  "pduVariableMap": {
    "1.3.6.1.4.1.12345.1.3": "value1"
  }
}

Full JSON Body Example - SNMP v3 No Authentication

{
  "type": "snmp",
  "name": "my-snmp-v3-noauth",
  "description": "SNMP v3 without authentication",
  "deployToWorker": true,
  "enabled": true,
  "version": "V3",
  "connectionString": "udp:192.168.1.2/162",
  "securityOrCommunityName": "securityUser",
  "retryCount": 3,
  "timeout": 5000,
  "messageType": "TRAP",
  "securityLevel": "NOAUTH_NOPRIV",
  "privacyProtocolList": [],
  "enableUserAuthentication": false,
  "securityName": null,
  "usmUserAuthenticationProtocol": null,
  "authPassphrase": null,
  "usmUserPrivacyProtocol": null,
  "privPassphrase": null,
  "pduOidForMessage": "1.3.6.1.4.1.12345.1.1",
  "pduOidForTime": "1.3.6.1.4.1.12345.1.2",
  "pduVariableMap": {
    "1.3.6.1.4.1.12345.1.3": "value1"
  }
}

Request Body Fields

Common Fields

Field	Type	Required	Default	Description
type	string	Yes	-	Connection type discriminator field. Identifies the connection type in API requests/responses.
name	string	Yes	-	Connection name (must match path parameter)
description	string	No	-	Connection description
deployToWorker	boolean	No	true	Whether to deploy to worker
enabled	boolean	No	true	Whether connection is enabled

SNMP Common Fields

Field	Type	Required	Default	Description
version	string	Yes	V1	SNMP version. See EnumSnmpVersion
connectionString	string	Yes	udp:192.168.1.2/162	Connection string (format: `protocol:host/port`)
securityOrCommunityName	string	Yes	-	Community name (v1/v2c) or security name (v3)
retryCount	integer	No	-	Number of retry attempts
timeout	integer	No	-	Timeout in milliseconds
messageType	string	No	-	Message type. See Enum Snmp Message Type
pduOidForMessage	string	Yes	-	OID for message content
pduOidForTime	string	No	-	OID for timestamp
pduVariableMap	object	No	Map of OID-value pairs for PDU variables

SNMP v3 Specific Fields

Field	Type	Required	Default	Description
securityLevel	string	No	-	Security level (v3 only). See EnumSnmpSecurityLevel
privacyProtocolList	array	No	[]	List of supported privacy protocols (v3 only). See EnumSnmpPrivacyProtocol
enableUserAuthentication	boolean	No	false	Enable user authentication (v3 only)
securityName	string	No	-	Security name (v3 only, required if enableUserAuthentication=true)
usmUserAuthenticationProtocol	string	No	-	Authentication protocol (v3 only, required if securityLevel=AUTH_NOPRIV or AUTH_PRIV). See EnumSnmpAuthenticationProtocol
authPassphrase	string	No	-	Authentication passphrase (v3 only, required if securityLevel=AUTH_NOPRIV or AUTH_PRIV, secret field)
usmUserPrivacyProtocol	string	No	-	Privacy protocol (v3 only, required if securityLevel=AUTH_PRIV). See EnumSnmpPrivacyProtocol
privPassphrase	string	No	-	Privacy passphrase (v3 only, required if securityLevel=AUTH_PRIV, secret field)

EnumSnmpVersion (version)

V1 - SNMP version 1 (default)
V2c - SNMP version 2c (community-based)
V3 - SNMP version 3 (user-based security)

Enum Snmp Message Type (messageType)

TRAP - SNMP trap (unacknowledged)
INFORM - SNMP inform (acknowledged)

EnumSnmpSecurityLevel (securityLevel) - v3 only

NOAUTH_NOPRIV - No authentication, no privacy
AUTH_NOPRIV - Authentication, no privacy
AUTH_PRIV - Authentication and privacy

EnumSnmpPrivacyProtocol (usmUserPrivacyProtocol, privacyProtocolList)

PrivAES128 - AES 128-bit encryption
PrivAES192 - AES 192-bit encryption
PrivAES192with3DES - AES 192-bit with 3DES
PrivAES256 - AES 256-bit encryption
PrivAES256with3DES - AES 256-bit with 3DES
PrivDES - DES encryption
Priv3DES - 3DES encryption

EnumSnmpAuthenticationProtocol (usmUserAuthenticationProtocol)

AuthMD5 - MD5 authentication
AuthSHA - SHA-1 authentication
AuthHMAC128SHA224 - HMAC-SHA224 authentication
AuthHMAC192SHA256 - HMAC-SHA256 authentication
AuthHMAC256SHA384 - HMAC-SHA384 authentication
AuthHMAC384SHA512 - HMAC-SHA512 authentication

Notes

version, connectionString, securityOrCommunityName, and pduOidForMessage are required.
connectionString format: protocol:host/port (e.g., udp:192.168.1.2/162, tcp:192.168.1.2/162)
For SNMP v1/v2c: securityOrCommunityName is the community name (e.g., “public”).
For SNMP v3: securityOrCommunityName is the security name (user name).
SNMP v3 fields are only used when version: "V3".
securityLevel determines required fields:
- NOAUTH_NOPRIV: No additional fields required
- AUTH_NOPRIV: Requires usmUserAuthenticationProtocol and authPassphrase
- AUTH_PRIV: Requires usmUserAuthenticationProtocol, authPassphrase, usmUserPrivacyProtocol, and privPassphrase
enableUserAuthentication: true enables USM (User-based Security Model) authentication.
pduVariableMap is a map of OID-value pairs for additional PDU variables.
pduOidForTime is optional OID for timestamp.

Response

Success Response (200 OK)

{
  "success": true,
  "deploymentResult": {
    "success": true,
    "deploymentResults": [
      {
        "environmentName": "production",
        "success": true,
        "message": "Deployment successful"
      }
    ]
  }
}

cURL Example

curl -X POST \
  "https://demo.apinizer.com/apiops/projects/MyProject/connections/my-snmp-connection/" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "snmp",
    "name": "my-snmp-connection",
    "description": "SNMP v1 trap connection",
    "deployToWorker": true,
    "enabled": true,
    "version": "V1",
    "connectionString": "udp:192.168.1.2/162",
    "securityOrCommunityName": "public",
    "retryCount": 3,
    "timeout": 5000,
    "messageType": "TRAP",
    "pduOidForMessage": "1.3.6.1.4.1.12345.1.1",
    "pduOidForTime": "1.3.6.1.4.1.12345.1.2",
    "pduVariableMap": {
      "1.3.6.1.4.1.12345.1.3": "value1"
    }
  }'

Update Connection

Endpoint

PUT /apiops/projects/{projectName}/connections/{connectionName}/

Request

Headers

Header	Value
Authorization	Bearer
Content-Type	application/json

Path Parameters

Parameter	Type	Required	Description
projectName	string	Yes	Project name
connectionName	string	Yes	Connection name (must match name in body)

Request Body

Full JSON Body Example

{
  "type": "snmp",
  "name": "my-snmp-connection",
  "description": "Updated SNMP connection for traps",
  "deployToWorker": true,
  "enabled": true,
  "version": "V3",
  "connectionString": "udp:192.168.1.10/162",
  "securityOrCommunityName": "private",
  "retryCount": 5,
  "timeout": 10000,
  "messageType": "INFORM",
  "securityLevel": "AUTH_PRIV",
  "privacyProtocolList": ["PrivDES", "PrivAES128"],
  "enabledUserAuthentication": true,
  "securityName": "snmp_user",
  "usmUserAuthenticationProtocol": "AuthSHA",
  "authPassphrase": "auth_password",
  "usmUserPrivacyProtocol": "PrivAES128",
  "privPassphrase": "priv_password",
  "pduUdpForMessage": "1.3.6.1.4.1.12345.2.1",
  "pduUdpForTime": "1.3.6.1.4.1.12345.2.2",
  "pduVariableMap": {
    "1.3.6.1.4.1.12345.2.3": "value1",
    "1.3.6.1.4.1.12345.2.4": "value2"
  }
}

Note: Request body structure is the same as Create Connection. All fields should be provided for update.

Response

Success Response (200 OK)

{
  "success": true,
  "deploymentResult": {
    "success": true,
    "deploymentResults": [...]
  }
}

Delete Connection

Endpoint

DELETE /apiops/projects/{projectName}/connections/{connectionName}/

Request

Headers

Header	Value
Authorization	Bearer

Path Parameters

Parameter	Type	Required	Description
projectName	string	Yes	Project name
connectionName	string	Yes	Connection name

Response

Success Response (200 OK)

{
  "success": true,
  "deploymentResult": {
    "success": true,
    "deploymentResults": [...]
  }
}

Notes and Warnings

SNMP Versions:
- V1 - Legacy version, community-based security (default)
- V2c - Improved version, community-based security
- V3 - Modern version, user-based security (recommended for production)
Connection String:
- Format: protocol:host/port
- Protocols: udp (default, port 162) or tcp (port 162)
- Example: udp:192.168.1.2/162 or tcp:192.168.1.2/162
Security Levels (v3):
- NOAUTH_NOPRIV - No security (not recommended)
- AUTH_NOPRIV - Authentication only (messages authenticated but not encrypted)
- AUTH_PRIV - Full security (messages authenticated and encrypted, recommended)
Message Types:
- TRAP - Unacknowledged notification (fire-and-forget)
- INFORM - Acknowledged notification (waits for acknowledgment)
Authentication Protocols:
- AuthMD5 - MD5 (legacy, not recommended)
- AuthSHA - SHA-1 (widely supported)
- AuthHMAC* - HMAC variants (stronger security)
Privacy Protocols:
- PrivAES128 - AES 128-bit (recommended)
- PrivAES256 - AES 256-bit (strongest)
- PrivDES - DES (legacy, not recommended)
PDU Variables:
- pduOidForMessage - OID for message content (required)
- pduOidForTime - OID for timestamp (optional)
- pduVariableMap - Additional OID-value pairs
Community/Security Name:
- v1/v2c: Community name (e.g., “public”, “private”)
- v3: Security name (user name)
Passphrases:
- Minimum length: 8 characters (SNMP requirement)
- Use strong passphrases in production
- Passphrases are masked in responses
Retry and Timeout:
- retryCount - Number of retry attempts
- timeout - Timeout in milliseconds
- Important for INFORM messages (acknowledgment required)
Deployment: Connection changes require deployment to take effect. Set deployToWorker: true or deploy manually.

List Connections - List all connections
Get Connection - Get a specific connection
Create Connection - General connection creation guide
Update Connection - General connection update guide
Delete Connection - General connection deletion guide

Home

​General Information

​Connection Type

​UI Documentation

​Endpoints

​List Connections

​Get Connection

​Create Connection

​Update Connection

​Delete Connection

​List Connections

​Endpoint

​Request

​Headers

​Path Parameters

​cURL Example

​Get Connection

​Endpoint

​Request

​Headers

​Path Parameters

​Response

​Success Response (200 OK)

​cURL Example

​Create Connection

​Endpoint

​Request

​Headers

​Path Parameters

​Request Body

Full JSON Body Example - SNMP v1 Trap

Full JSON Body Example - SNMP v2c Inform

Full JSON Body Example - SNMP v3 with Authentication and Privacy

Full JSON Body Example - SNMP v3 with Authentication Only

Full JSON Body Example - SNMP v3 No Authentication

Request Body Fields

Common Fields

SNMP Common Fields

SNMP v3 Specific Fields

​EnumSnmpVersion (version)

​Enum Snmp Message Type (messageType)

​EnumSnmpSecurityLevel (securityLevel) - v3 only

​EnumSnmpPrivacyProtocol (usmUserPrivacyProtocol, privacyProtocolList)

​EnumSnmpAuthenticationProtocol (usmUserAuthenticationProtocol)

​Notes

​Response

​Success Response (200 OK)

​cURL Example

​Update Connection

​Endpoint

​Request

​Headers

​Path Parameters

​Request Body

Full JSON Body Example

​Response

​Success Response (200 OK)

​Delete Connection

​Endpoint

​Request

​Headers

​Path Parameters

​Response

​Success Response (200 OK)

​Notes and Warnings

​Related Documentation

General Information

Connection Type

UI Documentation

Endpoints

List Connections

Get Connection

Create Connection

Update Connection

Delete Connection

List Connections

Endpoint

Request

Headers

Path Parameters

cURL Example

Get Connection

Endpoint

Request

Headers

Path Parameters

Response

Success Response (200 OK)

cURL Example

Create Connection

Endpoint

Request

Headers

Path Parameters

Request Body

EnumSnmpVersion (version)

Enum Snmp Message Type (messageType)

EnumSnmpSecurityLevel (securityLevel) - v3 only

EnumSnmpPrivacyProtocol (usmUserPrivacyProtocol, privacyProtocolList)

EnumSnmpAuthenticationProtocol (usmUserAuthenticationProtocol)

Notes

Response

Success Response (200 OK)

cURL Example

Update Connection

Endpoint

Request

Headers

Path Parameters

Request Body

Response

Success Response (200 OK)

Delete Connection

Endpoint

Request

Headers

Path Parameters

Response

Success Response (200 OK)

Notes and Warnings

Related Documentation