Create new app

Create new app

post

Creates a new app and returns a new publicKey

Authorizations

Body

urlstringOptional

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

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

platformstring · enumRequired

The platform of the app. Either ios or android.

Example: iosPossible values:

fileTypestring · enumOptional

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

Example: zipPossible values:

notestringOptional

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

Example: This is a note

timeoutnumberOptional

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

timeLimitnumberOptional

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

Example: 200

maxConcurrentnumberOptional

The maximum number of concurrent sessions allowed for this app.

Example: 5

referrerHostnamesRestrictedstring[]Optional

A list of hostnames that are allowed to embed this app.
If not set, any hostname can embed the app.

Example: ["example.com","example2.com"]

disabledbooleanOptional

Disables streaming for this app.

Example: false

disableHomebooleanOptional

Disables the home button on the iOS simulator when available.

Example: false

useLastFramebooleanOptional

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

Example: false

buttonTextstringOptional

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

Default: Tap to playExample: Start

postSessionButtonTextstringOptional

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

Default: Tap to playExample: Restart

launchUrlstringOptional

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

Example: https://example.com/deeplink

Responses

200

OK

application/json

post

HTTPcURLJavaScriptPython

POST /v1/apps HTTP/1.1
Host: api.appetize.io
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 530

{
  "url": "https://example.com/app.zip",
  "platform": "ios",
  "fileType": "zip",
  "note": "This is a note",
  "timeout": 120,
  "timeLimit": 200,
  "maxConcurrent": 5,
  "referrerHostnamesRestricted": [
    [
      "example.com",
      "example2.com"
    ]
  ],
  "disabled": false,
  "disableHome": false,
  "useLastFrame": false,
  "buttonText": "Start",
  "postSessionButtonText": "Restart",
  "launchUrl": "https://example.com/deeplink",
  "appPermissions": {
    "run": "authenticated",
    "networkProxy": "public",
    "networkIntercept": "public",
    "debugLog": "public",
    "adbConnect": "public",
    "androidPackageManager": "public"
  }
}

200

OK

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