Secret Subresource
You can provide secret data for specific Microvisor-empowered IoT devices using the Secret subresource. Secrets are intended as a way to upload data such as PKI keys and other confidential items to the Twilio cloud so they need not be baked into application code. Instead, the application code running on the device retrieves the Secret when it needs the information.
Unlike Device Configs, Device Secrets' values cannot be accessed via the API once they have been created. The retrieval actions listed below will return Secrets' metadata, not their values.
Each Secret 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 Secret with the key wifi_password
, but each device can have only one Secret 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 Secret. For example, you might used base64 encoding. Your application must decode the value back to binary after acquiring it from the Twilio cloud.
Secret subresources are accessed at these endpoints:
_10https://microvisor.twilio.com/v1/Devices/{sid}/Secrets
_10https://microvisor.twilio.com/v1/Devices/{UniqueName}/Secrets
Device Secrets are accessible only by the specified device. For Secrets that are made available to all devices associated with a given account, please see Account-level Secrets.
Warning
Secrets can't yet be updated. If you need to change a Secret's value, delete it, and then create a new Secret with the same key.
Resource properties
device_sid
type: SID<UV>
A 34-character string that uniquely identifies the parent Device.
key
type: string
The secret key; up to 100 characters.
date_rotated
type: string<date-time>
url
type: string<uri>
The absolute URL of the Secret.
POST https://microvisor.twilio.com/v1/Devices/{DeviceSid}/Secrets
URI parameters
DeviceSid
type: string
A 34-character string that uniquely identifies the Device.
Request body parameters
Key
type: stringRequired
The secret key; up to 100 characters.
Value
type: stringRequired
The secret value; up to 4096 characters.
_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
_11const accountSid = process.env.TWILIO_ACCOUNT_SID;
_11const authToken = process.env.TWILIO_AUTH_TOKEN;
_11const client = require('twilio')(accountSid, authToken);
_11client.microvisor.v1.devices('UVxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx')
_11 .create({key: 'key', value: 'value'})
_11 .then(device_secret => console.log(device_secret.deviceSid));
_10 "device_sid": "UVXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10 "date_rotated": "2021-01-01T12:34:56Z",
_10 "url": "https://microvisor.twilio.com/v1/Devices/UVXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Secrets/first"
URI parameters
DeviceSid
type: string
A 34-character string that uniquely identifies the Device.
Key
type: string
The secret key; up to 100 characters.
_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
_11const accountSid = process.env.TWILIO_ACCOUNT_SID;
_11const authToken = process.env.TWILIO_AUTH_TOKEN;
_11const client = require('twilio')(accountSid, authToken);
_11client.microvisor.v1.devices('UVxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx')
_11 .deviceSecrets('key_name')
_11 .then(device_secret => console.log(device_secret.deviceSid));
_10 "device_sid": "UVXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10 "date_rotated": "2021-01-01T12:34:57Z",
_10 "url": "https://microvisor.twilio.com/v1/Devices/UVXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Secrets/first"
GET https://microvisor.twilio.com/v1/Devices/{DeviceSid}/Secrets
URI parameters
DeviceSid
type: string
A 34-character string that uniquely identifies the Device.
PageSize
type: integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
Page
type: integer
The page index. This value is simply for client state.
PageToken
type: string
The page token. This is provided by the API.
_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
_11const accountSid = process.env.TWILIO_ACCOUNT_SID;
_11const authToken = process.env.TWILIO_AUTH_TOKEN;
_11const client = require('twilio')(accountSid, authToken);
_11client.microvisor.v1.devices('UVxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx')
_11 .then(deviceSecrets => deviceSecrets.forEach(d => console.log(d.deviceSid)));
_25 "device_sid": "UVXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_25 "date_rotated": "2021-01-01T12:34:56Z",
_25 "url": "https://microvisor.twilio.com/v1/Devices/UVXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Secrets/first"
_25 "device_sid": "UVXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_25 "date_rotated": "2021-01-01T12:34:57Z",
_25 "url": "https://microvisor.twilio.com/v1/Devices/UVXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Secrets/second"
_25 "first_page_url": "https://microvisor.twilio.com/v1/Devices/UVXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Secrets?PageSize=50&Page=0",
_25 "previous_page_url": "https://microvisor.twilio.com/v1/Devices/UVXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Secrets?PageSize=50&Page=0",
_25 "url": "https://microvisor.twilio.com/v1/Devices/UVXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Secrets?PageSize=50&Page=0",
_25 "next_page_url": "https://microvisor.twilio.com/v1/Devices/UVXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Secrets?PageSize=50&Page=1",
DELETE https://microvisor.twilio.com/v1/Devices/{DeviceSid}/Secrets/{Key}
URI parameters
DeviceSid
type: string
A 34-character string that uniquely identifies the Device.
Key
type: string
The secret key; up to 100 characters.
_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
_10const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10const authToken = process.env.TWILIO_AUTH_TOKEN;
_10const client = require('twilio')(accountSid, authToken);
_10client.microvisor.v1.devices('UVxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx')
_10 .deviceSecrets('key_name')