eGauge WebAPI (4.6)

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 capture service allows collecting waveform data for configured input channels.

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).

The meter configuration service.

The endpoints under /config provide common method semantics and atomicity guarantees as described below.

The alert configuration of the meter.

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.

The custom alert.

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

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 user-selected name of this custom alert.

The priority of this custom alert. Zero is the lowest, seven the highest priority.

The alert reporting configuration. Alerts may be reported via a web server or via an email server.

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.

The user name to provide to the email server for authentication purposes.

The password to provide to the email server for authentication purposes.

This resource is write-only.

The "From" email address to use when sending an email alert. If set to an empty string, the email server will use a default address.

The email destinations to send the alerts to.

An email destination to send the alerts to.

The destination email address to send the alert to.

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 configuration for reporting alerts via web server.

The minimum priority that is required for a new alert to generate a report to the web server. When a report is generated, all other unacknowledged alerts are also reported, even if they have a priority lower than the value indicated by this resource.

The options to use when sending an alert report to the web server.

This resource is available only if /config/alert/reporter/web/service is an empty string.

Multiple options can be specified in the string by separating them with a comma. Supported options are:

• deflate: Use HTTP Content-Encoding deflate when transmitting the alert report.

• gzip: Use HTTP Content-Encoding gzip when transmitting the alert report.

• secure: Only send the alert report if the server's HTTP certificate can be verified by the meter. This option is ignored if /config/net/http/client/insecure is true.

The password to be provided to the web server for authentication purposes.

This resource is write-only

The name of the alert service provider to use for reporting alerts.

To set this to a non-empty value please use the service activation command since that ensures the service provider knows to expect alerts from this meter. The body of the activation request should contain member service set to the string alert and provider set to name of the desired service provider.

The URI of the web server to use for reporting alerts.

This resource is available only if /config/alert/reporter/web/service is an empty string.

The user name to provide to the web server for authentication purposes. If this string is not empty, the user name and the password are both sent to the web server using HTTP Basic authorization. For security reasons, this should only be used when connecting to the server via an encrypted connection (https).

This resource is available only if /config/alert/reporter/web/service is an empty string.

The priority of each system-generated alert. /sys/alert provides a description of these alerts.

The priority of this system alert.

The BACnet configuration.

The BACnet server configuration.

The BACnet over IPv4 configuration.

The IPv4 port number used by the server when bip is enabled in /config/bacnet/server/enable. The default value is 0xBAC0 (47808).

The list of BACnet protocols that are enabled. An empty list indicates that the BACnet server is disabled. The meter is currently restricted to supporting a single protocol at a time, so this array may have at most one element.