Update existing app

Updates an existing app with a new build while keeping the same publicKey or changes app settings. To unset a previously set field send a null value.

POSThttps://api.appetize.io/v1/apps/{app_publicKey}

Path parameters

publicKey*string

The publicKey for the app.

Example: "p7nww3n6ubq73r1nh9jtauqy8w"

Body

urlstring

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

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

platformenum

The platform of the app. Either ios or android.

Example: "ios"

iosandroid

fileTypeenum

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

Example: "zip"

ziptar.gzapk

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

referrerHostnamesRestrictedarray of string

A list of hostnames that are allowed to embed this app.

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

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

Example: "Start"

postSessionButtonTextstring

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"

appPermissionsobject

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

See App Permissions for more information.

Response

Body

publicKeystring

The unique identifier for the newly created app.

createdstring (date-time)

The date and time when the app was created.

updatedstring (date-time)

The date and time when the app was last updated.

platformstring

The platform of the app (ios or android).

versionCodeinteger

Increments with each update of the app.

Request

const response = await fetch('https://api.appetize.io/v1/apps/{app_publicKey}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

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

PreviousCreate new app NextDirect file uploads

Last updated 3 days ago

const response = await fetch('https://api.appetize.io/v1/apps/{app_publicKey}', { method: 'POST', headers: { "Content-Type": "application/json" }, body: JSON.stringify({}), }); const data = await response.json();