Menu

Expand

App Resource

Microvisor Public Beta

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:

https://microvisor.twilio.com/v1/Apps/{sid}
https://microvisor.twilio.com/v1/Apps/{uniqueName}

Application code represented by an App resource can be installed on a device using its Device resource.

New App resources

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:

curl -X POST https://microvisor-upload.twilio.com/v1/Apps \
  -H 'Content-Type: multipart/form-data' \
  -F File=@/path/to/app/bunde \
  -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 our support team. For more information on Twilio’s data retention and deletion policy, please see this support document.

App properties

Resource Properties in REST API format
sid
sid<KA> Not PII

A 34-character string that uniquely identifies this App.

account_sid
sid<AC> Not PII

The unique SID identifier of the Account.

hash
string Not PII

App manifest hash represented as hash_algorithm:hash_value.

unique_name
string Not PII

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.

date_created
date_time<iso8601> Not PII

The date that this App was created, given in ISO 8601 format.

date_updated
date_time<iso8601> Not PII

The date that this App was last updated, given in ISO 8601 format.

url
url Not PII

The URL of this resource.

links
uri_map Not PII

Get an App

get
https://microvisor.twilio.com/v1/Apps/{Sid}
Parameters
Parameters in REST API format
sid
Path
get sid_like<KA> Not PII

A 34-character string that uniquely identifies this App.

Example 1
Loading Code Sample...
        
        

        Request a single App resource

        Get all Apps

        get
        https://microvisor.twilio.com/v1/Apps
        Example 1
        Loading Code Sample...
              
              

              Request a list of all App resources

              Delete an App

              delete
              https://microvisor.twilio.com/v1/Apps/{Sid}
              Parameters
              Parameters in REST API format
              sid
              Path
              delete sid_like<KA> Not PII

              A 34-character string that uniquely identifies this App.

              Example 1
              Loading Code Sample...
                    
                    

                    Delete an App resource

                    Loading Code Sample...