Site

Site Syslog Alert

Changed on Aug 6, 2026

Retrieves the specified Syslog alert.

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

Request

Base URL
https://<host>:<port>
Auth
none declared
TypeScript
https://skmtc.dev/rapid7/apis/rapid7-vm-api/docs/api/3/sites/:id/alerts/syslog/:alertId/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

alertIdinteger required

The identifier of the alert.

Example:5

idinteger required

The identifier of the site.

Response

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 response

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

Changes

Aug 6, 20263a8197c22d71 Revision 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

Operation history