/config/alert/reporter

The alert reporting configuration. Alerts may be reported via a web server or via an email server.

Get /config/alert/reporter

SecurityApiKey
Request
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
Request samples
Response samples
application/json
{
  • "result": {
    },
  • "error": "Error message (present if an error occurred)."
}

Replace /config/alert/reporter

SecurityApiKey
Request
Request Body schema: application/json
object (configAlertReporterWeb)

The configuration for reporting alerts via web server.

object (configAlertReporterMail)

The configuration for reporting alerts via email server. If alert reporting via web server is enabled (/config/alert/reporter/web/uri is not empty), reporting via email server is disabled.

Responses
200

Normal response.

401

Unauthorized response.

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

Update /config/alert/reporter

SecurityApiKey
Request
Request Body schema: application/json
object (configAlertReporterWeb)

The configuration for reporting alerts via web server.

object (configAlertReporterMail)

The configuration for reporting alerts via email server. If alert reporting via web server is enabled (/config/alert/reporter/web/uri is not empty), reporting via email server is disabled.

Responses
200

Normal response.

401

Unauthorized response.

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

Delete /config/alert/reporter

Reset to default (reporting disabled).

SecurityApiKey
Responses
200

Normal response.

401

Unauthorized response.

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