Secret Resource

Danger

This is historical documentation, and tooling and console operations are no longer available.

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 Microvisor 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 Microvisor Cloud.

Secret resources are accessed at this endpoint:

https://microvisor.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.

Create an Account-level Secret

Action	Create an account-level Secret
Path	https://microvisor.com/v1/Secrets
Method	POST
Parameters	Name: key Value: {secret‘s name as a string} Name: value Value: {secret’s value as a string}

Retrieve an Account-level Secret’s Metadata

Action	Fetch an account-level Secret’s metadata
Path	https://microvisor.com/v1/Secrets/{Key}
Method	GET
Parameters	Name: key Value: {secret’s name as a string}

Delete an Account-level Secret

Action	Delete an account-level Secret
Path	https://microvisor.com/v1/Secrets/{Key}
Method	DELETE
Parameters	Name: key Value: {secret’s name as a string}