---
title: "Site Syslog Alerts"
method: PUT
path: "/api/3/sites/{id}/alerts/syslog"
tags: ["Site"]
---

# Site Syslog Alerts

`PUT /api/3/sites/{id}/alerts/syslog`

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

## Path parameters

- `id` integer, required — The identifier of the site.

## Request body

- SyslogAlert[] — Array of resources for updating all Syslog alerts defined in the site. Alerts defined in the site that are omitted from this request will be deleted from the site.
  - `enabled` boolean, required — Flag indicating the alert is enabled.
  - `enabledScanEvents` ScanEvents — Allows the user to specify which scan events generate an alert. Default values will be chosen if property is not specified as apart of the request. The default values are documented in the properties of `enabledScanEvents`.
    - `failed` boolean, required — Generates an alert when a scan fails. Default value is `false`.
    - `paused` boolean, required — Generates an alert when a scan pauses. Default value is `false`.
    - `resumed` boolean — Generates an alert when a scan resumes. Default value is `false`.
    - `started` boolean, required — Generates an alert when a scan starts. Default value is `false`.
    - `stopped` boolean, required — Generates an alert when a scan stops. Default value is `false`.
  - `enabledVulnerabilityEvents` VulnerabilityEvents — Allows the user to specify which vulnerability result events generate an alert. Default values will be chosen if property is not specified as apart of the request. The default values are documented in the properties of `enabledVulnerabilityEvents`.
    - `confirmedVulnerabilities` boolean, required — Generates an alert for vulnerability results of confirmed vulnerabilties. A vulnerability is "confirmed" when asset-specific vulnerability tests, such as exploits, produce positive results. Default value is `true`.
    - `potentialVulnerabilities` boolean, required — Generates an alert for vulnerability results of potential vulnerabilties. A vulnerability is "potential" if a check for a potential vulnerabilty is positive. Default value is `true`.
    - `unconfirmedVulnerabilities` boolean, required — Generates an alert for vulnerability results of unconfirmed vulnerabilties. A vulnerability is "unconfirmed" when a version of a scanned service or software is known to be vulnerable, but there is no positive verification. Default value is `true`.
    - `vulnerabilitySeverity` 'any_severity' | 'severe_and_critical' | 'only_critical', required — Generates an alert for vulnerability results of the selected vulnerability severity. Default value is `"any_severity"`.
  - `id` integer — The identifier of the alert.
  - `links` Link[], required — Hypermedia links to corresponding or related resources.
    - `deprecation` string
    - `href` string — A hypertext reference, which is either a URI (see <a target="_blank" rel="noopener noreferrer" href="https://tools.ietf.org/html/rfc3986">RFC 3986</a>) or URI template (see <a target="_blank" rel="noopener noreferrer" href="https://tools.ietf.org/html/rfc6570">RFC 6570</a>).
    - `hreflang` string
    - `media` string
    - `rel` string — The link relation type. This value is one from the <a target="_blank" rel="noopener noreferrer" href="https://tools.ietf.org/html/rfc5988#section-6.2">Link Relation Type Registry</a> or is the type of resource being linked to.
    - `title` string
    - `type` string
  - `maximumAlerts` integer — 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`.
  - `name` string, required — The name of the alert.
  - `notification` 'SMTP' | 'SNMP' | 'Syslog', required — The type of alert.
  - `server` string, required — The Syslog server to send messages to.

## Response `200`

OK

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `404` — Not Found
- `500` — Internal Server Error
- `503` — Service Unavailable

---

[API](https://skmtc.net/rapid7/apis/rapid7-vm-api.md) · [All operations](https://skmtc.net/rapid7/apis/rapid7-vm-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/rapid7/rapid7-vm-api/versions/3a8197c22d71/schema)