Normal response.
Unauthorized response.
{- "result": {
- "min-priority": 7,
- "service": "",
- "options": "gzip,secure",
- "user": "jsmith",
- "password": "secret!"
}, - "error": "Error message (present if an error occurred)."
}| min-priority | integer (configAlertReporterWebMinPriority) [ 0 .. 7 ] The minimum priority that is required for a new alert to generate a report to the web server. When a report is generated, all other unacknowledged alerts are also reported, even if they have a priority lower than the value indicated by this resource. |
| service | string (configAlertReporterWebService) The name of the alert service provider to use for reporting alerts. After writing this resource with a non-empty string, the service needs to be activated in a separate step. TODO: SHOW HOW TO DO THIS. |
| uri | string (configAlertReporterWebUri) The URI of the web server to use for reporting alerts. This resource is available only if /config/alert/reporter/web/service is an empty string. |
| options | string (configAlertReporterWebOptions) The options to use when sending an alert report to the web server. This resource is available only if /config/alert/reporter/web/service is an empty string. Multiple options can be specified in the string by separating them with a comma. Supported options are:
|
| user | string (configAlertReporterWebUser) The user name to provide to the web server for authentication purposes. If this string is not empty, the user name and the password are both sent to the web server using HTTP Basic authorization. For security reasons, this should only be used when connecting to the server via an encrypted connection (https). This resource is available only if /config/alert/reporter/web/service is an empty string. |
| password | string (configAlertReporterWebPassword) The password to be provided to the web server for authentication purposes. This resource is write-only |
Normal response.
Unauthorized response.
{ }{- "status": "OK",
- "error": "Error message (present if an error occurred)."
}| min-priority | integer (configAlertReporterWebMinPriority) [ 0 .. 7 ] The minimum priority that is required for a new alert to generate a report to the web server. When a report is generated, all other unacknowledged alerts are also reported, even if they have a priority lower than the value indicated by this resource. |
| service | string (configAlertReporterWebService) The name of the alert service provider to use for reporting alerts. After writing this resource with a non-empty string, the service needs to be activated in a separate step. TODO: SHOW HOW TO DO THIS. |
| uri | string (configAlertReporterWebUri) The URI of the web server to use for reporting alerts. This resource is available only if /config/alert/reporter/web/service is an empty string. |
| options | string (configAlertReporterWebOptions) The options to use when sending an alert report to the web server. This resource is available only if /config/alert/reporter/web/service is an empty string. Multiple options can be specified in the string by separating them with a comma. Supported options are:
|
| user | string (configAlertReporterWebUser) The user name to provide to the web server for authentication purposes. If this string is not empty, the user name and the password are both sent to the web server using HTTP Basic authorization. For security reasons, this should only be used when connecting to the server via an encrypted connection (https). This resource is available only if /config/alert/reporter/web/service is an empty string. |
| password | string (configAlertReporterWebPassword) The password to be provided to the web server for authentication purposes. This resource is write-only |
Normal response.
Unauthorized response.
{ }{- "status": "OK",
- "error": "Error message (present if an error occurred)."
}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.
Normal response.
Unauthorized response.
{- "status": "OK",
- "error": "Error message (present if an error occurred)."
}