Menu

Expand

Secret resource

You can provide configuration data for multiple Microvisor-empowered IoT devices using the Secret resource. Secrets are intended as a way to upload confidential data to the Twilio cloud so it need not be baked into application code. Instead, the application code running on the device retrieves the Secret when it needs the information.

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

https://microvisor.twilio.com/v1/Secrets

Secret resources are accessible from all devices associated with an account. For Secrets that are made available to specific devices, please see Device Secrets.

AccountSecret properties

Resource Properties in REST API format
key
string Not PII

The secret key; up to 100 characters.

date_rotated
date_time<iso8601> Not PII

url
url Not PII

The absolute URL of the Secret.

Create an account-level Secret

post
https://microvisor.twilio.com/v1/Secrets
Parameters
Parameters in REST API format
key
Required
post string Not PII

The secret key; up to 100 characters.

value
Required
post string Not PII

The secret value; up to 4096 characters.

Example 1
Loading Code Sample...
        
        

        Create an account-level Secret

        Retrieve an account-level Secret’s metadata

        get
        https://microvisor.twilio.com/v1/Secrets/{Key}
        Parameters
        Parameters in REST API format
        key
        Path
        get string Not PII

        The secret key; up to 100 characters.

        Example 1
        Loading Code Sample...
              
              

              Fetch an account-level Secret’s metadata

              Delete an account-level Secret

              delete
              https://microvisor.twilio.com/v1/Secrets/{Key}
              Parameters
              Parameters in REST API format
              key
              Path
              delete string Not PII

              The secret key; up to 100 characters.

              Example 1
              Loading Code Sample...
                    
                    

                    Delete an account-level Secret

                    Loading Code Sample...