Sign in

v1

latestOpenAPI 3.1.02026-08-06330343826.1 KB
Site

Site SMTP Alert

Updates the specified SMTP alert.

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

Path parameters

alertIdinteger required

The identifier of the alert.

Example:5

The identifier of the alert.

idinteger required

The identifier of the site.

The identifier of the site.

Request body

enabledboolean required

Flag indicating the alert is enabled.

idinteger

The identifier of the alert.

limitAlertTextboolean

Reports basic information in the alert, if enabled.

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.

recipientsstring[] required

The recipient list. At least one recipient must be specified. Each recipient must be a valid e-mail address.

relayServerstring required

The SMTP server/relay to send messages through.

senderEmailAddressstring

The sender e-mail address that will appear in the from field.

Example request

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

Response

OK