/sys/func/alert

Documents the alert eScript functions. These functions are available only for eScript expressions evaluated as part of alert conditions.

Get /sys/func/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/sys/func/alert

Request samples

curl
Python
JavaScript
Go

Response samples

application/json

{"result": {"dayavg": {"arg": [{"name": "reg",
"type": "string"
}
],
"help": "Calculates the 24-hour average value for register <arg>reg</arg>.",
"min-args": 1
},
"cumul": {"arg": [{"name": "reg",
"type": "string"
},
{"name": "time",
"type": "#"
}
],
"help": "Returns the cumulative value of register named <arg>reg</arg> at time <arg>time</arg>.  If <arg>time</arg> is not specified, the current time is used.",
"min-args": 1
}
},
"error": "Error message (present if an error occurred)."
}

➔ Next to /sys/func/alert/{name}