/config/alert/reporter/mail/to/{idx}

An email destination to send the alerts to.

Get /config/alert/reporter/mail/to/{idx}

SecurityApiKey
Request
path Parameters
idx
required
integer [ 0 .. 3 ]

The index of an alert destination.

query Parameters
max-depth
integer >= 1

Limit output depth of the response. See Max-Depth.

Example: max-depth=2
filter
string

Response filter string. See Filter-Spec.

Example: filter={foo,bar}
Responses
200

Normal response.

401

Unauthorized response.

get/config/alert/reporter/mail/to/{idx}
Request samples
Response samples
application/json
{
  • "result": {
    },
  • "error": "Error message (present if an error occurred)."
}

Replace /config/alert/reporter/mail/to/{idx}

SecurityApiKey
Request
path Parameters
idx
required
integer [ 0 .. 3 ]

The index of an alert destination.

Request Body schema: application/json
format
string (configAlertReporterMailToItemFormat)

The reporting format to use for this destination. Valid values are:

  • short: Report only the newest alert with the highest priority.

  • full: Report all unacknowledged alerts that are pending in order from highest to lowest priority.

min-priority
integer (configAlertReporterMailToItemMinPriority) [ 0 .. 7 ]

The minimum priority that is required for a new alert to generate an email. When an email is generated, other lower priority alerts may also be included if they are unacknowledged and the reporting format allows it.

address
string (configAlertReporterMailToItemAddress)

The destination email address to send the alert to.

Responses
200

Normal response.

401

Unauthorized response.

put/config/alert/reporter/mail/to/{idx}
Request samples
application/json
{ }
Response samples
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}

Update /config/alert/reporter/mail/to/{idx}

SecurityApiKey
Request
path Parameters
idx
required
integer [ 0 .. 3 ]

The index of an alert destination.

Request Body schema: application/json
format
string (configAlertReporterMailToItemFormat)

The reporting format to use for this destination. Valid values are:

  • short: Report only the newest alert with the highest priority.

  • full: Report all unacknowledged alerts that are pending in order from highest to lowest priority.

min-priority
integer (configAlertReporterMailToItemMinPriority) [ 0 .. 7 ]

The minimum priority that is required for a new alert to generate an email. When an email is generated, other lower priority alerts may also be included if they are unacknowledged and the reporting format allows it.

address
string (configAlertReporterMailToItemAddress)

The destination email address to send the alert to.

Responses
200

Normal response.

401

Unauthorized response.

post/config/alert/reporter/mail/to/{idx}
Request samples
application/json
{ }
Response samples
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}

Delete /config/alert/reporter/mail/to/{idx}

Reset to default. See the descriptions of the individual endpoints for their default values. Commonly, arrays and strings are cleared to empty, numbers are cleared to 0, and booleans are cleared to false.

SecurityApiKey
Request
path Parameters
idx
required
integer [ 0 .. 3 ]

The index of an alert destination.

Responses
200

Normal response.

401

Unauthorized response.

delete/config/alert/reporter/mail/to/{idx}
Request samples
Response samples
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}