Microvisor is in a pre-release phase and the information contained in this document is subject to change. Some features referenced below may not be fully available until Microvisor's General Availability (GA) release.
A Device instance represents a single Microvisor-empowered IoT device. For clarity, device (no cap) refers to physical hardware. Device (initial cap) refers to a Device API resource.
Device resources are accessed at this endpoint:
_10https://microvisor.twilio.com/v1/Devices
Make a GET request to the endpoint to receive a list (in JSON) of all Device resources.
Every Device instance can be referenced in the API either by its unique SID or a user-defined unique name:
_10https://microvisor.twilio.com/v1/Devices/{sid}_10https://microvisor.twilio.com/v1/Devices/{uniqueName}
The Device instance representing a real device is used to deploy uploaded code to that device.
Customers may request that device data be deleted. If you wish to do so, please contact Twilio Support through the Console or Help Center. For more information on Twilio's data retention and deletion policy, please see this support document.
A 34-character string that uniquely identifies this Device.
^UV[0-9a-fA-F]{32}$Min length: 34Max length: 34A developer-defined string that uniquely identifies the Device. This value must be unique for all Devices on this Account. The unique_name value may be used as an alternative to the sid in the URL path to address the resource.
The unique SID identifier of the Account.
^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34Information about the target App and the App reported by this Device. Contains the properties target_sid, date_targeted, update_status (one of up-to-date, pending and error), update_error_code, reported_sid and date_reported.
Object specifying whether application logging is enabled for this Device. Contains the properties enabled and date_expires.
The date that this Device was created, given in ISO 8601 format.
The date that this Device was last updated, given in ISO 8601 format.
The absolute URLs of related resources.
The table below describes the available status values of a Device instance:
| Status | Description |
|---|---|
up-to-date | The device has received with the most recent application code deployed to it |
scheduled | Application code has been marked for deployment but has yet to be installed on the device |
error | Application code marked for deployment could not be downloaded for some reason |
GET https://microvisor.twilio.com/v1/Devices/{Sid}A 34-character string that uniquely identifies this Device.
GET https://microvisor.twilio.com/v1/DevicesHow many resources to return in each list page. The default is 50, and the maximum is 1000.
1Maximum: 1000The page token. This is provided by the API.
POST https://microvisor.twilio.com/v1/Devices/{Sid}A 34-character string that uniquely identifies this Device.
A unique and addressable name to be assigned to this Device by the developer. It may be used in place of the Device SID.
A Boolean flag specifying whether to enable application logging. Logs will be enabled or extended for 24 hours.
Set to true to restart the App running on the Device.
Remember, a Device can be identified either by is SID, or by its unique name, if you have applied one.
Application code logging is enabled by default.
Restarting an app using this call will instruct Microvisor to start the loaded application afresh. This can be a useful call to make during remote debugging, particularly if your application is experiencing unexpected behavior right after it starts.