/config/alert

The alert configuration of the meter.

Get /config/alert

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

Replace /config/alert

SecurityApiKey
Request
Request Body schema: application/json
Array of objects (configAlertCustom)

Up to 32 custom alerts.

Custom alerts consist of an arbitrary boolean condition that is checked at certain times. When the condition evaluates to true, the alert is triggered.

object (configAlertReporter)

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

sys-prio
Array of integers (configAlertSysPrio)

The priority of each system-generated alert. /sys/alert provides a description of these alerts.

Responses
200

Normal response.

401

Unauthorized response.

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

Update /config/alert

SecurityApiKey
Request
Request Body schema: application/json
Array of objects (configAlertCustom)

Up to 32 custom alerts.

Custom alerts consist of an arbitrary boolean condition that is checked at certain times. When the condition evaluates to true, the alert is triggered.

object (configAlertReporter)

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

sys-prio
Array of integers (configAlertSysPrio)

The priority of each system-generated alert. /sys/alert provides a description of these alerts.

Responses
200

Normal response.

401

Unauthorized response.

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

Delete /config/alert

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
Responses
200

Normal response.

401

Unauthorized response.

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