eGauge Meter API
License Common Documentation License 1.0
eGauge Meter API
The eGauge WebAPI is a JSON-based API that provides access to eGauge meters. It offers secure means to read device data, configure the device, and perform various control operations.
The WebAPI is intended to eventually replace the eGauge XML API. For new applications, developers are encouraged to use WebAPI rather than the legacy XML API.
The authentication service. Clients can use this to obtain and manage tokens that grant access to the other resources in this API.
The meter uses JSON Web Tokens (JWT or simply token) to restrict access to protected resources. Clients must include such tokens in requests via the HTTP Authorization header. This header must have the form:
Authorization: Bearer JWT
where JWT is a valid token.
Tokens are valid for a limited time; typically for about 10 minutes. However, a meter may revoke a token earlier, e.g., due to a reboot.
The service provides the ability to execute various operations for their side effects, such as rebooting the meter. Unless stated otherwise, the resources in this service are available only to users with the save right (see /auth/rights).
An eScript expression that returns the value to use on the left hand side of the comparison.
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.An eScript expression that returns the value that to use on the right hand side of the comparison.
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.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.The configuration for reporting alerts via email server. If alert reporting via web server is enabled (/config/alert/reporter/web/uri is not empty), reporting via email server is disabled.
The hostname of a mail server that speaks the SMTP protocol. If this is set to an empty string, the meter will attempt to deliver mail directly to the destination host. Many Internet service providers block direct mail delivery, so leaving this string empty generally results in alert emails getting blocked.
curl -i -X GET \ 'https://webapi.egauge.net/_mock/webapi/4.6/openapi/config/alert/reporter/mail/to?filter=string&max-depth=1' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>'
{ "result": [ { … } ], "error": "Error message (present if an error occurred)." }
The reporting format to use for this destination. Valid values are:
short: Report only the newest alert with the highest priority.
full: Report all unacknowledged alerts that are pending in order from highest to lowest priority.
The minimum priority that is required for a new alert to generate an email. When an email is generated, other lower priority alerts may also be included if they are unacknowledged and the reporting format allows it.
The destination email address to send the alert to.
curl -i -X PUT \ https://webapi.egauge.net/_mock/webapi/4.6/openapi/config/alert/reporter/mail/to \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'Content-Type: application/json' \ -d '[ { "format": "string", "min-priority": 3, "address": "user@site.com" } ]'
{ "status": "OK", "error": "Error message (present if an error occurred)." }
The reporting format to use for this destination. Valid values are:
short: Report only the newest alert with the highest priority.
full: Report all unacknowledged alerts that are pending in order from highest to lowest priority.
The minimum priority that is required for a new alert to generate an email. When an email is generated, other lower priority alerts may also be included if they are unacknowledged and the reporting format allows it.
The destination email address to send the alert to.