Sign in

v1

latestOpenAPI 3.1.02026-08-06330343826.1 KB
Site

Site SNMP Alerts

Updates all SNMP alerts for the specified site in a single request using the array of resources defined in the request body.

put/api/3/sites/{id}/alerts/snmp

Path parameters

idinteger required

The identifier of the site.

The identifier of the site.

Request body

communitystring required

The SNMP community name.

enabledboolean required

Flag indicating the alert is enabled.

idinteger

The identifier of the alert.

maximumAlertsinteger

The maximum number of alerts that will be issued. To disable maximum alerts, omit the property in the request or specify the property with a value of null.

namestring required

The name of the alert.

notification'SMTP' | 'SNMP' | 'Syslog' required

The type of alert.

serverstring required

The SNMP management server.

Example request

[
  {
    "links": [
      {
        "href": "https://hostname:3780/api/3/...",
        "rel": "self"
      }
    ]
  }
]

Response

OK