Config Sub-resource

Danger

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

You can provide configuration data for specific Microvisor-empowered IoT devices using the Config sub-resource. Configs are intended as a way to upload data such as API keys, PKI certificates, and other items to the Microvisor 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 Microvisor Cloud.

Config sub-resources are accessed at these endpoints:

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

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.

Create a Device Config

Action	Create a device-level Config
Path	`https://microvisor.com/v1/Devices/{DeviceId}/Configs`
Method	`POST`
Parameters	Name: `device_id` Value: `{secret‘s name as a string}` Name: `value` Value: `UVxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx`

Retrieve a Device Config’s Value

Action	Retrieve a device-level Config
Path	`https://microvisor.com/v1/Devices/{DeviceId}/Configs/{Key}`
Method	`GET`
Parameters	Name: `device_id` Value: `UVxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx` Name: `key` Value: `{key_name}`

List All of a Device’s Configs

Action	List all of a device’s Configs
Path	`https://microvisor.com/v1/Devices/{DeviceId}/Configs`
Method	`GET`
Parameters	Name: `device_id` Value: `UVxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx`

Delete a Device Config

Action	Delete a device-level Config
Path	`https://microvisor.com/v1/Devices/{DeviceId}/Configs/{Key}`
Method	`DELETE`
Parameters	Name: `device_id` Value: `UVxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx` Name: `key` Value: `{key_name}`