Powered by Redocly

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

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.

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

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

The index of an alert destination.

Responses
200

Normal response.

401

Unauthorized response.

get/config/alert/reporter/mail/to/{idx}/format
Request samples 
Response samples 
application/json
{
  • "result": "string",
  • "error": "Error message (present if an error occurred)."
}
Replace /config/alert/reporter/mail/to/{idx}/format
SecurityApiKey 
Request 
path Parameters
idx
required
integer  [ 0 .. 3 ] 
The index of an alert destination.


 
Request Body schema: application/json
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.
    

    • 



 
Responses 
200
Normal response.


401
Unauthorized response.


put/config/alert/reporter/mail/to/{idx}/format
Request samples 
application/json
"string"
Response samples 
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}
Update /config/alert/reporter/mail/to/{idx}/format
SecurityApiKey 
Request 
path Parameters
idx
required
integer  [ 0 .. 3 ] 
The index of an alert destination.


 
Request Body schema: application/json
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.
    

    • 



 
Responses 
200
Normal response.


401
Unauthorized response.


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


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}/format
Request samples 
Response samples 
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}
➔ Next to /config/alert/reporter/mail/to/{idx}/min-priority