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

Config resource


You can provide configuration data for multiple Microvisor-empowered IoT devices using the Config resource. 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 account.

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 resources are accessed at this endpoint:


_10
https://microvisor.twilio.com/v1/Configs

Config resources are accessible from all devices associated with an account. For Configs that are made available to specific devices, please see Device 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 Secrets, which are, from the API perspective, write- and delete-only.


AccountConfig Properties

accountconfig-properties page anchor
keystring
Not PII

The config key; up to 100 characters.


date_updatedstring<date-time>

valuestring

The config value; up to 4096 characters.


urlstring<uri>

The absolute URL of the Config.


Create an account-level Config

create-an-account-level-config page anchor
POST https://microvisor.twilio.com/v1/Configs

Request body parameters

request-body-parameters page anchor
Keystringrequired

The config key; up to 100 characters.


Valuestringrequired

The config value; up to 4096 characters.

Create an account-level Config

create-an-account-level-config-1 page anchor
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.accountConfigs
_10
.create({key: 'key_name', value: 'value'})
_10
.then(account_config => console.log(account_config.key));

Output

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


Retrieve an account-level Config

retrieve-an-account-level-config page anchor
GET https://microvisor.twilio.com/v1/Configs/{Key}

Keystringrequired

The config key; up to 100 characters.

Fetch an account-level Config

fetch-an-account-level-config page anchor
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.accountConfigs('Key_name')
_10
.fetch()
_10
.then(account_config => console.log(account_config.key));

Output

_10
{
_10
"key": "Key_name",
_10
"value": "place",
_10
"date_updated": "2021-01-01T12:34:57Z",
_10
"url": "https://microvisor.twilio.com/v1/Configs/first"
_10
}


Delete an account-level Config

delete-an-account-level-config page anchor
DELETE https://microvisor.twilio.com/v1/Configs/{Key}

Keystringrequired

The config key; up to 100 characters.

Delete an account-level Config

delete-an-account-level-config-1 page anchor
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.accountConfigs('key_name').remove();


Rate this page: