RArapid7
Site

Site Syslog Alert

Changed on

Updates the specified Syslog alert.

put/api/3/sites/{id}/alerts/syslog/{alertId}

Request

Path parameters

alertIdinteger required

The identifier of the alert.

Example:5
idinteger required

The identifier of the site.

Request body

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 Syslog server to send messages to.

Example request

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

Response

OK

Example response

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

Changes

  • 3a8197c22d71Revision changes
    • breaking

      added required request body

    • 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

    • info

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