Skip to contentSkip to navigationSkip to topbar
Rate this page:
On this page

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:


_10
https://microvisor.twilio.com/v1/Devices/{sid}/Configs
_10
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.

(warning)

Warning

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

device-config-properties page anchor
Resource properties
device_sidtype: SID<UV>Not PII

A 34-character string that uniquely identifies the parent Device.


keytype: stringNot PII

The config key; up to 100 characters.


valuetype: stringNot PII

The config value; up to 4096 characters.


date_updatedtype: string<DATE TIME>Not PII

urltype: string<URI>Not PII

The absolute URL of the Config.


POST https://microvisor.twilio.com/v1/Devices/{DeviceSid}/Configs

Parameters

create-parameters page anchor
URI parameters
DeviceSidtype: stringNot PII
Path Parameter

A 34-character string that uniquely identifies the Device.


Request body parameters
Keytype: stringNot PII
Required

The config key; up to 100 characters.


Valuetype: stringNot PII
Required

The config value; up to 4096 characters.

Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_11
// Download the helper library from https://www.twilio.com/docs/node/install
_11
// Find your Account SID and Auth Token at twilio.com/console
_11
// and set the environment variables. See http://twil.io/secure
_11
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_11
const authToken = process.env.TWILIO_AUTH_TOKEN;
_11
const client = require('twilio')(accountSid, authToken);
_11
_11
client.microvisor.v1.devices('UVxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx')
_11
.deviceConfigs
_11
.create({key: 'key', value: 'value'})
_11
.then(device_config => console.log(device_config.deviceSid));

Output

_10
{
_10
"device_sid": "UVXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10
"key": "first",
_10
"value": "some value",
_10
"date_updated": "2021-01-01T12:34:56Z",
_10
"url": "https://microvisor.twilio.com/v1/Devices/UVXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Configs/first"
_10
}


Retrieve a Device Config's value

retrieve-a-device-configs-value page anchor
GET https://microvisor.twilio.com/v1/Devices/{DeviceSid}/Configs/{Key}

URI parameters
DeviceSidtype: stringNot PII
Path Parameter

A 34-character string that uniquely identifies the Device.


Keytype: stringNot PII
Path Parameter

The config key; up to 100 characters.

Retrieve a Device Config's value

retrieve-a-device-configs-value-1 page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_11
// Download the helper library from https://www.twilio.com/docs/node/install
_11
// Find your Account SID and Auth Token at twilio.com/console
_11
// and set the environment variables. See http://twil.io/secure
_11
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_11
const authToken = process.env.TWILIO_AUTH_TOKEN;
_11
const client = require('twilio')(accountSid, authToken);
_11
_11
client.microvisor.v1.devices('UVxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx')
_11
.deviceConfigs('key_name')
_11
.fetch()
_11
.then(device_config => console.log(device_config.deviceSid));

Output

_10
{
_10
"device_sid": "UVXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10
"key": "key_name",
_10
"value": "some value",
_10
"date_updated": "2021-01-01T12:34:57Z",
_10
"url": "https://microvisor.twilio.com/v1/Devices/UVXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Configs/first"
_10
}


List all of a Device's Configs

list-all-of-a-devices-configs page anchor
GET https://microvisor.twilio.com/v1/Devices/{DeviceSid}/Configs

URI parameters
DeviceSidtype: stringNot PII
Path Parameter

A 34-character string that uniquely identifies the Device.


PageSizetype: integerNot PII
Query Parameter

How many resources to return in each list page. The default is 50, and the maximum is 1000.


Pagetype: integerNot PII
Query Parameter

The page index. This value is simply for client state.


PageTokentype: stringNot PII
Query Parameter

The page token. This is provided by the API.

List all of a Device's Configs

list-all-of-a-devices-configs-1 page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_11
// Download the helper library from https://www.twilio.com/docs/node/install
_11
// Find your Account SID and Auth Token at twilio.com/console
_11
// and set the environment variables. See http://twil.io/secure
_11
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_11
const authToken = process.env.TWILIO_AUTH_TOKEN;
_11
const client = require('twilio')(accountSid, authToken);
_11
_11
client.microvisor.v1.devices('UVxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx')
_11
.deviceConfigs
_11
.list({limit: 20})
_11
.then(deviceConfigs => deviceConfigs.forEach(d => console.log(d.deviceSid)));

Output

_12
{
_12
"configs": [],
_12
"meta": {
_12
"page": 0,
_12
"page_size": 50,
_12
"first_page_url": "https://microvisor.twilio.com/v1/Devices/UVXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Configs?PageSize=50&Page=0",
_12
"previous_page_url": "https://microvisor.twilio.com/v1/Devices/UVXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Configs?PageSize=50&Page=0",
_12
"url": "https://microvisor.twilio.com/v1/Devices/UVXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Configs?PageSize=50&Page=0",
_12
"next_page_url": "https://microvisor.twilio.com/v1/Devices/UVXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Configs?PageSize=50&Page=1",
_12
"key": "configs"
_12
}
_12
}


DELETE https://microvisor.twilio.com/v1/Devices/{DeviceSid}/Configs/{Key}

URI parameters
DeviceSidtype: stringNot PII
Path Parameter

A 34-character string that uniquely identifies the Device.


Keytype: stringNot PII
Path Parameter

The config key; up to 100 characters.

Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_10
// Download the helper library from https://www.twilio.com/docs/node/install
_10
// Find your Account SID and Auth Token at twilio.com/console
_10
// and set the environment variables. See http://twil.io/secure
_10
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10
const authToken = process.env.TWILIO_AUTH_TOKEN;
_10
const client = require('twilio')(accountSid, authToken);
_10
_10
client.microvisor.v1.devices('UVxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx')
_10
.deviceConfigs('key_name')
_10
.remove();


Rate this page: