Powered by Redocly

/config/alert/custom/{idx}/cond

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

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

SecurityApiKey
Request
path Parameters
idx
required
integer >= 0

The index of a custom alert.

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/{idx}/cond
Request samples 
Response samples 
application/json
{
  • "result": {
    },
  • "error": "Error message (present if an error occurred)."
}
Replace /config/alert/custom/{idx}/cond
SecurityApiKey 
Request 
path Parameters
idx
required
integer  >= 0 
The index of a custom alert.


 
Request Body schema: application/json
lhs
string (configAlertCustomItemCondLhs) 
An eScript expression that returns the
value to use on the left hand side of the comparison.


 
op
string (configAlertCustomItemCondOp) 
The comparison-operator to use for comparing the left-hand-side
expression lhs against the right-hand side expression rhs.  It
may be one of:


    

  • <: Condition is true if lhs is less than rhs.
    • 

  • <=: Condition is true if lhs is less-than-or-equal to rhs.
    • 

  • ==: Condition is true if lhs is equal to rhs.
    • 

  • !=: Condition is true if lhs differs from rhs.
    • 

  • >=: Condition is true if lhs is greater-than-or-equal to rhs.
    • 

  • >: Condition is true if lhs is greater than rhs.
    • 



 Enum: "<" "<=" "==" "!=" ">=" ">"  
rhs
string (configAlertCustomItemCondRhs) 
An eScript expression that returns the
value that to use on the right hand side of the comparison.


 
Responses 
200
Normal response.


401
Unauthorized response.


put/config/alert/custom/{idx}/cond
Request samples 
application/json
{ }
Response samples 
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}
Update /config/alert/custom/{idx}/cond
SecurityApiKey 
Request 
path Parameters
idx
required
integer  >= 0 
The index of a custom alert.


 
Request Body schema: application/json
lhs
string (configAlertCustomItemCondLhs) 
An eScript expression that returns the
value to use on the left hand side of the comparison.


 
op
string (configAlertCustomItemCondOp) 
The comparison-operator to use for comparing the left-hand-side
expression lhs against the right-hand side expression rhs.  It
may be one of:


    

  • <: Condition is true if lhs is less than rhs.
    • 

  • <=: Condition is true if lhs is less-than-or-equal to rhs.
    • 

  • ==: Condition is true if lhs is equal to rhs.
    • 

  • !=: Condition is true if lhs differs from rhs.
    • 

  • >=: Condition is true if lhs is greater-than-or-equal to rhs.
    • 

  • >: Condition is true if lhs is greater than rhs.
    • 



 Enum: "<" "<=" "==" "!=" ">=" ">"  
rhs
string (configAlertCustomItemCondRhs) 
An eScript expression that returns the
value that to use on the right hand side of the comparison.


 
Responses 
200
Normal response.


401
Unauthorized response.


post/config/alert/custom/{idx}/cond
Request samples 
application/json
{ }
Response samples 
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}
Delete /config/alert/custom/{idx}/cond
Reset to default condition which is always false.


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}/cond
Request samples 
Response samples 
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}
➔ Next to /config/alert/custom/{idx}/cond/lhs