/config/alert/custom/{idx}/detail

Alert detail message. This may be up to 255 bytes in length. The following sequences within this string get replaced as follows:

  • %% is replaced by a single percent character.
  • %l is replaced by the value of the lhs expression.
  • %r is replaced by the value of the rhs expression.
  • %L is replaced by the lhs expression string.
  • %R is replaced by the rhs expression string.

Get /config/alert/custom/{idx}/detail

SecurityApiKey
Request
path Parameters
idx
required
integer >= 0

The index of a custom alert.

Responses
200

Normal response.

401

Unauthorized response.

get/config/alert/custom/{idx}/detail
Request samples
Response samples
application/json
{
  • "result": "It is hot in here: %l C!",
  • "error": "Error message (present if an error occurred)."
}

Replace /config/alert/custom/{idx}/detail

SecurityApiKey
Request
path Parameters
idx
required
integer >= 0

The index of a custom alert.

Request Body schema: application/json
string (configAlertCustomItemDetail)

Alert detail message. This may be up to 255 bytes in length. The following sequences within this string get replaced as follows:

  • %% is replaced by a single percent character.
  • %l is replaced by the value of the lhs expression.
  • %r is replaced by the value of the rhs expression.
  • %L is replaced by the lhs expression string.
  • %R is replaced by the rhs expression string.
Responses
200

Normal response.

401

Unauthorized response.

put/config/alert/custom/{idx}/detail
Request samples
application/json
"It is hot in here: %l C!"
Response samples
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}

Update /config/alert/custom/{idx}/detail

SecurityApiKey
Request
path Parameters
idx
required
integer >= 0

The index of a custom alert.

Request Body schema: application/json
string (configAlertCustomItemDetail)

Alert detail message. This may be up to 255 bytes in length. The following sequences within this string get replaced as follows:

  • %% is replaced by a single percent character.
  • %l is replaced by the value of the lhs expression.
  • %r is replaced by the value of the rhs expression.
  • %L is replaced by the lhs expression string.
  • %R is replaced by the rhs expression string.
Responses
200

Normal response.

401

Unauthorized response.

post/config/alert/custom/{idx}/detail
Request samples
application/json
"It is hot in here: %l C!"
Response samples
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}

Delete /config/alert/custom/{idx}/detail

Reset to empty string.

SecurityApiKey
Request
path Parameters
idx
required
integer >= 0

The index of a custom alert.

Responses
200

Normal response.

401

Unauthorized response.

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