Create new app

Create new app

Creates a new app and returns a new publicKey

post

/apps

Authorizations

Body

urlstring

A publicly accessible link to your .zip, .tar.gz, or .apk file.

Example: https://example.com/app.zip

notestring

A note for your own purposes, will appear on your management dashboard.

Example: This is a note

timeoutnumber

The number of seconds to wait until automatically ending the session due to user inactivity.

Must be 30, 60, 90, 120, 180, 300, 600, 1800, 3600 or 7200, default is 120 or the account default if set.

Example: 120

timeLimitnumber

The maximum number of seconds a session can run, before it is automatically ended.

Example: 200

maxConcurrentnumber

The maximum number of concurrent sessions allowed for this app.

Example: 5

disabledboolean

Disables streaming for this app.

Example: false

disableHomeboolean

Disables the home button on the iOS simulator when available.

Example: false

useLastFrameboolean

Show the last image on the screen in the simulator after the session ends.

Example: false

buttonTextstring · default: Tap to play

Customize the message prompting the user to start the session. Default is "Tap to play".

Example: Start

postSessionButtonTextstring · default: Tap to play

Customize the message prompting the user to restart the session. Default is "Tap to play".

Example: Restart

launchUrlstring

Specify a deep link to bring your users to a specific location when your app is launched.

Example: https://example.com/deeplink

platformstring · enumrequired

The platform of the app. Either ios or android.

Example: ios

Options: ios, android

fileTypestring · enum

The type of file that the url points to. Default is zip for iOS, apk for Android.

Example: zip

Options: zip, tar.gz, apk

referrerHostnamesRestrictedstring[]

appPermissionsobject

Values for each field determine who can perform the specified action.

See App Permissions for more information.

Example: {"run":"authenticated","networkProxy":"public","networkIntercept":"public","debugLog":"public","adbConnect":"public","androidPackageManager":"public"}

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.appetize.io/v1/apps' \
  --header 'Authorization: Basic username:password' \
  --header 'Content-Type: application/json' \
  --data '{"url":"https://example.com/app.zip","note":"This is a note","timeout":120,"timeLimit":200,"maxConcurrent":5,"disabled":false,"disableHome":false,"useLastFrame":false,"buttonText":"Start","postSessionButtonText":"Restart","launchUrl":"https://example.com/deeplink","platform":"ios","fileType":"zip","referrerHostnamesRestricted":[["example.com","example2.com"]],"appPermissions":{"run":"authenticated","networkProxy":"public","networkIntercept":"public","debugLog":"public","adbConnect":"public","androidPackageManager":"public"}}'

200

200

{
  "publicKey": "p7nww3n6ubq73r1nh9jtauqy8w",
  "created": "2016-02-10T17:46:14.089Z",
  "updated": "2016-02-10T17:46:14.089Z",
  "platform": "ios",
  "versionCode": 1
}

OK