Settings
The settings API allows application settings to be retrieved and set.
Retrieve all settings
URL | /api/<auth_token>/settings |
Method | GET |
Version | 1.0 |
Description
Retrieves the current application settings of the device.
Path arguments
Name | Type | Description | Required |
---|---|---|---|
auth_token | string | The authentication token used to authenticate the request. | Required |
Response
Returns a object containing the application settings as key/value pairs.
Retrieve specific settings
URL | /api/<auth_token>/settings |
Method | POST |
Version | 1.0 |
Description
Retrieves certain settings determines by the body of the method.
Path arguments
Name | Type | Description | Required |
---|---|---|---|
auth_token | string | The authentication token used to authenticate the request. | Required |
Body
Send an array of strings used to limit the settings returned. If no strings are passed, then all settings are returned. You may use an asterisk at the end of a string to return all settings prefixed with the term.
Response
Returns dictionary of settings as key/value pairs.
Change settings
URL | /api/<auth_token>/settings |
Method | PUT |
Version | 1.0 |
Description
Changes the application settings on the device.
Path arguments
Name | Type | Description | Required |
---|---|---|---|
auth_token | string | The authentication token used to authenticate the request. | Required |
Body
Send a dictionary of key/value pairs for the settings you wish to update on the device.
Response
Returns an object with a success/error property indicating if the updates were set.