Config Subresource
You can provide configuration data for specific Microvisor-empowered IoT devices using the Config subresource. Configs are intended as a way to upload data such as API keys, PKI certificates, and other items to the Twilio cloud so they need not be baked into application code. Instead, the application code running on the device retrieves the Config when it needs the information.
Each Config is a key:value pair which your application code can access using Microvisor System Calls.
Keys are text identifiers of up to 100 characters in length. They must be unique for a given device. For example, devices A and B can both have Configs with the key cloud_service_api_key, but each device can have only one Config with that key.
Values must also be supplied as text, of up to 4096 characters in length. If you wish to make binary data available to your devices, you will need to encode it as text before creating the Config. For example, you might used base64 encoding. Your application must decode the value back to binary after acquiring it from the Twilio cloud.
Config subresources are accessed at these endpoints:
https://microvisor.twilio.com/v1/Devices/{sid}/Configs
https://microvisor.twilio.com/v1/Devices/{UniqueName}/Configs
Device Configs are accessible only by the specified device. For Configs that are made available to all devices associated with a given account, please see Account-level Configs.
It is possible for anyone with account access to read back the value of any Config. If you have information which, once created, you would not like to be accessible to other account holders, use Device Secrets, which are, from the API perspective, write- and delete-only.
Configs can’t yet be updated. If you need to change a Config’s value, delete it first, and then create a new Config with the same key.
Device Config properties
| Resource Properties in REST API format | |
|---|---|
device_sid
|
A 34-character string that uniquely identifies the parent Device. |
key
|
The config key; up to 100 characters. |
value
|
The config value; up to 4096 characters. |
date_updated
|
|
url
|
The absolute URL of the Config. |
Create a Device Config
https://microvisor.twilio.com/v1/Devices/{DeviceSid}/Configs
Parameters
| Parameters in REST API format | |
|---|---|
device_sid
Path
|
A 34-character string that uniquely identifies the Device. |
key
Required
|
The config key; up to 100 characters. |
value
Required
|
The config value; up to 4096 characters. |
Example 1
Retrieve a Device Config’s value
https://microvisor.twilio.com/v1/Devices/{DeviceSid}/Configs/{Key}
Parameters
| Parameters in REST API format | |
|---|---|
device_sid
Path
|
A 34-character string that uniquely identifies the Device. |
key
Path
|
The config key; up to 100 characters. |
Example 1
List all of a Device’s Configs
https://microvisor.twilio.com/v1/Devices/{DeviceSid}/Configs
Parameters
| Parameters in REST API format | |
|---|---|
device_sid
Path
|
A 34-character string that uniquely identifies the Device. |
Example 1
Delete a Device Config
https://microvisor.twilio.com/v1/Devices/{DeviceSid}/Configs/{Key}
Parameters
| Parameters in REST API format | |
|---|---|
device_sid
Path
|
A 34-character string that uniquely identifies the Device. |
key
Path
|
The config key; up to 100 characters. |
Example 1
Need some help?
We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd by visiting Twilio's Stack Overflow Collective or browsing the Twilio tag on Stack Overflow.
