RArapid7
Site

Site SNMP Alert

Changed on

Retrieves the specified SNMP alert.

get/api/3/sites/{id}/alerts/snmp/{alertId}

Request

Path parameters

alertIdinteger required

The identifier of the alert.

Example:5
idinteger required

The identifier of the site.

Response

OK

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 response

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

Changes

  • 3a8197c22d71Revision changes
    • info

      added the media type application/json;charset=UTF-8 for the response with the status

    • info

      added the media type application/json;charset=UTF-8 for the response with the status

    • info

      added the media type application/json;charset=UTF-8 for the response with the status

    • info

      added the media type application/json;charset=UTF-8 for the response with the status

    • info

      added the media type application/json;charset=UTF-8 for the response with the status