Powered by Redocly

/config/alert/custom

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.

Get /config/alert/custom

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/custom
Request samples 
Response samples 
application/json
{
  • "result": [
    ],
  • "error": "Error message (present if an error occurred)."
}
Replace /config/alert/custom
SecurityApiKey 
Request 
Request Body schema: application/json
 Array 
name
string (configAlertCustomItemName) 
The user-selected name of this custom alert.


 
detail
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.
    • 



 
frequency
string (configAlertCustomItemFrequency) 
The frequency with which this custom alert should be checked.
Possible values are:


    

  • sec: The alert will be checked once a second.
    • 

  • min: The alert will be checked once a minute.
    • 

  • hr: The alert will be checked once an hour.
    • 

  • dy: The alert will be checked once a day.
    • 

  • wk: The alert will be checked once a week.
    • 

  • mon: The alert will be checked once a month.
    • 

  • an: The alert will be checked once a year.
    • 



 Enum: "sec" "min" "hr" "dy" "wk" "mon" "an"  
priority
integer (configAlertCustomItemPriority)   [ 0 .. 7 ] 
The priority of this custom alert.  Zero is the lowest, seven the
highest priority.


 
object (configAlertCustomItemCond) 
The boolean condition consists of three parts: lhs op rhs. lhs
and rhs are arbitrary expressions and op must be a comparison
operator.


 
Responses 
200
Normal response.


401
Unauthorized response.


put/config/alert/custom
Request samples 
application/json
[
  • { }
]
Response samples 
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}
Update /config/alert/custom
SecurityApiKey 
Request 
Request Body schema: application/json
 Array 
name
string (configAlertCustomItemName) 
The user-selected name of this custom alert.


 
detail
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.
    • 



 
frequency
string (configAlertCustomItemFrequency) 
The frequency with which this custom alert should be checked.
Possible values are:


    

  • sec: The alert will be checked once a second.
    • 

  • min: The alert will be checked once a minute.
    • 

  • hr: The alert will be checked once an hour.
    • 

  • dy: The alert will be checked once a day.
    • 

  • wk: The alert will be checked once a week.
    • 

  • mon: The alert will be checked once a month.
    • 

  • an: The alert will be checked once a year.
    • 



 Enum: "sec" "min" "hr" "dy" "wk" "mon" "an"  
priority
integer (configAlertCustomItemPriority)   [ 0 .. 7 ] 
The priority of this custom alert.  Zero is the lowest, seven the
highest priority.


 
object (configAlertCustomItemCond) 
The boolean condition consists of three parts: lhs op rhs. lhs
and rhs are arbitrary expressions and op must be a comparison
operator.


 
Responses 
200
Normal response.


401
Unauthorized response.


post/config/alert/custom
Request samples 
application/json
[
  • { }
]
Response samples 
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}
Delete /config/alert/custom
Reset to empty array.


SecurityApiKey 
Responses 
200
Normal response.


401
Unauthorized response.


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