Skip to contentSkip to navigationSkip to topbar
Rate this page:
On this page

App Resource


(warning)

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:


_10
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:


_10
https://microvisor.twilio.com/v1/Apps/{sid}
_10
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

new-app-resources page anchor

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:


_10
curl -X POST https://microvisor-upload.twilio.com/v1/Apps \
_10
-H 'Content-Type: multipart/form-data' \
_10
-F File=@/path/to/app/bundle \
_10
-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.

(information)

Property nameTypePIIDescription
sidSID<KA>
Not PII

A 34-character string that uniquely identifies this App.

Pattern: ^KA[0-9a-fA-F]{32}$Min length: 34Max length: 34

account_sidSID<AC>

The unique SID identifier of the Account.

Pattern: ^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34

hashstring

App manifest hash represented as hash_algorithm:hash_value.


unique_namestring

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_createdstring<date-time>

The date that this App was created, given in ISO 8601(link takes you to an external page) format.


date_updatedstring<date-time>

The date that this App was last updated, given in ISO 8601(link takes you to an external page) format.


urlstring<uri>

The URL of this resource.


linksobject<uri-map>

GET https://microvisor.twilio.com/v1/Apps/{Sid}

Path parameters

path-parameters page anchor
Property nameTypeRequiredPIIDescription
Sidstringrequired

A 34-character string that uniquely identifies this App.

Request a single App resource

request-a-single-app-resource page anchor
curl

_10
curl -X GET "https://microvisor.twilio.com/v1/Apps/KAxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
_10
-u $TWILIO_ACCOUNT_SID:$TWILIO_AUTH_TOKEN

Output

_12
{
_12
"sid": "KAxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
_12
"account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_12
"hash": "hash",
_12
"unique_name": "look at this crazy app",
_12
"date_created": "2015-07-30T20:00:00Z",
_12
"date_updated": "2015-07-30T20:00:00Z",
_12
"url": "https://microvisor.twilio.com/v1/Apps/KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_12
"links": {
_12
"app_manifests": "https://microvisor.twilio.com/v1/Apps/KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Manifest"
_12
}
_12
}


GET https://microvisor.twilio.com/v1/Apps

Property nameTypeRequiredPIIDescription
PageSizeintegerOptional

How many resources to return in each list page. The default is 50, and the maximum is 1000.

Minimum: 1Maximum: 1000

PageintegerOptional

The page index. This value is simply for client state.

Minimum: 0

PageTokenstringOptional

The page token. This is provided by the API.

Request a list of all App resources

request-a-list-of-all-app-resources page anchor
curl

_10
curl -X GET "https://microvisor.twilio.com/v1/Apps?PageSize=20" \
_10
-u $TWILIO_ACCOUNT_SID:$TWILIO_AUTH_TOKEN

Output

_25
{
_25
"apps": [
_25
{
_25
"sid": "KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_25
"account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_25
"hash": "hash",
_25
"unique_name": "unique name",
_25
"date_created": "2015-07-30T20:00:00Z",
_25
"date_updated": "2015-07-30T20:00:00Z",
_25
"url": "https://microvisor.twilio.com/v1/Apps/KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_25
"links": {
_25
"app_manifests": "https://microvisor.twilio.com/v1/Apps/KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Manifest"
_25
}
_25
}
_25
],
_25
"meta": {
_25
"page": 0,
_25
"page_size": 50,
_25
"first_page_url": "https://microvisor.twilio.com/v1/Apps?PageSize=50&Page=0",
_25
"previous_page_url": null,
_25
"url": "https://microvisor.twilio.com/v1/Apps?PageSize=50&Page=0",
_25
"next_page_url": null,
_25
"key": "apps"
_25
}
_25
}


DELETE https://microvisor.twilio.com/v1/Apps/{Sid}

Property nameTypeRequiredPIIDescription
Sidstringrequired

A 34-character string that uniquely identifies this App.

curl

_10
curl -X DELETE "https://microvisor.twilio.com/v1/Apps/KAxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
_10
-u $TWILIO_ACCOUNT_SID:$TWILIO_AUTH_TOKEN


Rate this page: