The push service configuration. This service is used to share the
meter data with a remote web server. The data is sent via an HTTP
POST
request.
Normal response.
Unauthorized response.
{- "result": {
- "interval": 60,
- "options": "json,gzip,epoch,sec,skip=59",
- "service": "",
- "user": "jsmith"
}, - "error": "Error message (present if an error occurred)."
}
interval | integer (configPushInterval) >= 1 The interval in seconds between push updates. A value of 60, for example, would cause the push service to attempt to send data to the remote web server once a minute. |
options | string (configPushOptions) The options controlling how data is pushed to the remote web
server. Multiple options must be separated by commas ( This resource is available only if /config/push/service is an empty string. Available options are:
By default, data is pushed with minute granularity (at most one row of data per minute). |
password | string (configPushPassword) The password to be provided to the remote web server for
authentication purposes. The password is submitted to the remote
web server as part of a
Basic HTTP
This resource is available only if /config/push/web/service is an empty string. This resource is write-only. |
service | string (configPushService) The name of a push service provider to shared data with. To set this to a non-empty value please use the service
activation command since that ensures the
push provider knows to expect data from this meter. The body of
the activation request should contain member |
uri | string (configPushUri) The URI of the web server to share data with. This resource is available only if /config/push/service is an empty string. |
user | string (configPushUser) 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 as part of a
Basic HTTP
This resource is available only if /config/push/web/service is an empty string. |
Normal response.
Unauthorized response.
{- "interval": 60,
- "options": "json,gzip,epoch,sec,skip=59",
- "service": "",
- "user": "jsmith"
}
{- "status": "OK",
- "error": "Error message (present if an error occurred)."
}
interval | integer (configPushInterval) >= 1 The interval in seconds between push updates. A value of 60, for example, would cause the push service to attempt to send data to the remote web server once a minute. |
options | string (configPushOptions) The options controlling how data is pushed to the remote web
server. Multiple options must be separated by commas ( This resource is available only if /config/push/service is an empty string. Available options are:
By default, data is pushed with minute granularity (at most one row of data per minute). |
password | string (configPushPassword) The password to be provided to the remote web server for
authentication purposes. The password is submitted to the remote
web server as part of a
Basic HTTP
This resource is available only if /config/push/web/service is an empty string. This resource is write-only. |
service | string (configPushService) The name of a push service provider to shared data with. To set this to a non-empty value please use the service
activation command since that ensures the
push provider knows to expect data from this meter. The body of
the activation request should contain member |
uri | string (configPushUri) The URI of the web server to share data with. This resource is available only if /config/push/service is an empty string. |
user | string (configPushUser) 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 as part of a
Basic HTTP
This resource is available only if /config/push/web/service is an empty string. |
Normal response.
Unauthorized response.
{- "interval": 60,
- "options": "json,gzip,epoch,sec,skip=59",
- "service": "",
- "user": "jsmith"
}
{- "status": "OK",
- "error": "Error message (present if an error occurred)."
}
Reset to default. See the descriptions of the individual endpoints for their default values. Commonly, arrays and strings are cleared to empty, numbers are cleared to 0, and booleans are cleared to false
.
Normal response.
Unauthorized response.
{- "status": "OK",
- "error": "Error message (present if an error occurred)."
}