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.
An App instance represents application code uploaded to the Twilio cloud and able to be installed on one or more Microvisor-empowered Devices.
App resources are accessed at this endpoint:
https://microvisor.twilio.com/v1/Apps
Make a GET
request to the endpoint to receive a list (in JSON) of all App resources.
Every App instance can be referenced in the API either by its unique SID or a user-defined unique name:
1https://microvisor.twilio.com/v1/Apps/{sid}2https://microvisor.twilio.com/v1/Apps/{uniqueName}
Application code represented by an App resource can be installed on a device using its Device resource.
You do not create App resources directly. Instead, a new App resource is created for you whenever you upload application code, in the form of a Microvisor app bundle, to the Twilio cloud. This is achieved with the following curl
command:
1curl -X POST https://microvisor-upload.twilio.com/v1/Apps \2-H 'Content-Type: multipart/form-data' \3-F File=@/path/to/app/bundle \4-u <YOUR_ACCOUNT_SID>:<YOUR_AUTH_TOKEN>
This call will return App metadata in JSON form from which you can read the App's unique SID and which you will use to deploy the application to a device.
Customers may request that app 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 App.
^KA[0-9a-fA-F]{32}$
Min length: 34
Max length: 34
The unique SID identifier of the Account.
^AC[0-9a-fA-F]{32}$
Min length: 34
Max length: 34
A developer-defined string that uniquely identifies the App. This value must be unique for all Apps 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 date that this App was created, given in ISO 8601 format.
The date that this App was last updated, given in ISO 8601 format.
GET https://microvisor.twilio.com/v1/Apps/{Sid}
A 34-character string that uniquely identifies this App.
1curl -X GET "https://microvisor.twilio.com/v1/Apps/KAxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \2-u $TWILIO_ACCOUNT_SID:$TWILIO_AUTH_TOKEN
1{2"sid": "KAxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",3"account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",4"hash": "hash",5"unique_name": "look at this crazy app",6"date_created": "2015-07-30T20:00:00Z",7"date_updated": "2015-07-30T20:00:00Z",8"url": "https://microvisor.twilio.com/v1/Apps/KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",9"links": {10"app_manifests": "https://microvisor.twilio.com/v1/Apps/KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Manifest"11}12}
GET https://microvisor.twilio.com/v1/Apps
How many resources to return in each list page. The default is 50, and the maximum is 1000.
1
Maximum: 1000
The page token. This is provided by the API.
1curl -X GET "https://microvisor.twilio.com/v1/Apps?PageSize=20" \2-u $TWILIO_ACCOUNT_SID:$TWILIO_AUTH_TOKEN
1{2"apps": [3{4"sid": "KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",5"account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",6"hash": "hash",7"unique_name": "unique name",8"date_created": "2015-07-30T20:00:00Z",9"date_updated": "2015-07-30T20:00:00Z",10"url": "https://microvisor.twilio.com/v1/Apps/KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",11"links": {12"app_manifests": "https://microvisor.twilio.com/v1/Apps/KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Manifest"13}14}15],16"meta": {17"page": 0,18"page_size": 50,19"first_page_url": "https://microvisor.twilio.com/v1/Apps?PageSize=50&Page=0",20"previous_page_url": null,21"url": "https://microvisor.twilio.com/v1/Apps?PageSize=50&Page=0",22"next_page_url": null,23"key": "apps"24}25}
DELETE https://microvisor.twilio.com/v1/Apps/{Sid}
A 34-character string that uniquely identifies this App.