/
SNMP Agent

SNMP Agent

GET snmp_notification_agents

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns a list of all SNMP agents configurations.

Resource URL

http://{host}/api/2.0/snmp_notification_agents/.format

Example Request

GET 

  1. http://44.235.52.211/api/2.0/snmp_notification_agents/.json

[ { "SnmpNotificationAgent": { "id": 1, "title": "Default", "ip_address": "192.168.0.85", "port": 162, "community": "public", "network_id": 0, "keep_alive_interval": null, "send_clear_notification": 1, "modified": "1611142282208", "created": "1611142282208" } }, { "SnmpNotificationAgent": { "id": 2, "title": "test_SNMP", "ip_address": "10.20.45.30", "port": 162, "community": "public", "network_id": 1, "keep_alive_interval": null, "send_clear_notification": 1, "modified": "1619958809886", "created": "1619952146657" } } ]

 


 

GET snmp_notification_agents/{id}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns a single SNMP Agent configuration data.

Resource URL

http://{host}/api/2.0/snmp_notification_agents/{id}/.format

Parameters

Parameter

Data Type

Description

id
(required)

integer

The ID of the desired agent.

Example Request

GET 

  1. http://44.235.52.211/api/2.0/snmp_notification_agents/1/.json

{ "SnmpNotificationAgent": { "id": 1, "title": "Default", "ip_address": "192.168.0.85", "port": 162, "community": "public", "network_id": 0, "keep_alive_interval": null, "send_clear_notification": 1, "modified": "1611142282208", "created": "1611142282208" } }

 


 

POST snmp_notification_agents

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

POST

Adds a new SNMP agent.

Resource URL

http://{host}/api/2.0/snmp_notification_agents/.format

Example Request

POST 

  1. http://44.235.52.211/api/2.0/snmp_notification_agents/.json

{"SnmpNotificationAgent": { "id": 2, "title": "snmpAgent1", "ip_address": "192.168.0.101", "port": 162, "community": "public", "network_id": 0, "keep_alive_interval": null, "send_clear_notification": 0, "modified": "1385281627933", "created": "1385281627933" }}

 


 

POST snmp_notification_agents/{id}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

POST

Duplicates a specific SNMP Agent into a new one, resulting in identical agent data except for the title.

Resource URL

http://{host}/api/2.0/snmp_notification_agents/{id}/.format

Parameters

Parameter

Data Type

Description

id
(required)

integer

The ID of the agent to be copied.

Example Request

POST 

  1. http://44.235.52.211/api/2.0/snmp_notification_agents/3/.json

 


 

PUT snmp_notification_agents/{id}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

PUT

Updates a specific SNMP agent data.

Resource URL

http://{host}/api/2.0/snmp_notification_agents/{id}/.format

Parameters

Parameter

Data Type

Description

id
(required)

integer

The ID of the desired agent to be updated.

Example Request

PUT 

  1. http://44.235.52.211/api/2.0/snmp_notification_agents/3/.json

 


 

DELETE notification_agents/{id}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

DELETE

Deletes a specific SNMP Agent.

Resource URL

http://{host}/api/2.0/snmp_notification_agents/{id}/.format

Parameters

Parameter

Data Type

Description

id
(required)

integer

The ID of the desired agent to be deleted.

Example Request

DELETE 

  1. http://44.235.52.211/api/2.0/snmp_notification_agents/3/.json

 


 

GET snmp_notification_agents/command/test/{id}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Sends test SNMP notification for an existing agent.

Resource URL

http://{host}/api/2.0/snmp_notification_agents/command/test/{id}/.format

Parameters

Parameter

Data Type

Description

id
(required)

integer

The ID of the desired agent to send SNMP notification.

Example Request

GET

  1. http://44.235.52.211/api/2.0/snmp_notification_agents/command/test/1/.json

 

Related content

SNMP Devices
SNMP Devices
More like this
Notification Sets
Notification Sets
More like this
System Events Log
System Events Log
Read with this
Syslog Agents
Syslog Agents
More like this
v5.0_Notification Agents
v5.0_Notification Agents
More like this
Device Agents Statistics
Device Agents Statistics
More like this