Skip to content
Console
On this page

Install app on a lease

Installs an Android app (APK) on an ANDROID lease.

Installs an Android app (APK) on an ANDROID lease.

  • Path POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/leases/lease:installApp
  • Scope sandboxes:exec
  • Effect write — a successful call changes state.
  • Collection leases

Request

FieldTypeWhat it is
namestringThe name of the lease. Required.
apk_pathstringAn Android APK uploaded to the lease. Exactly one app path is required.
grant_permissionsboolGrant every Android runtime permission the app declares.
app_pathstringA ZIP containing one Simulator.app, uploaded to an IOS lease.
artifact_sha256stringThe exact ZIP SHA256; required for a Simulator install.
source_revisionstringThe caller's immutable source revision, returned in the install receipt.

Response

FieldTypeWhat it is
package_namestringThe Android package or iOS bundle identifier.
artifact_sha256stringThe verified uploaded artifact SHA256.
source_revisionstringThe source revision supplied with this exact artifact.
install_timetimestampUTC time of the successful install.

Errors

  • UNAUTHENTICATED — No valid key or token was presented.
  • PERMISSION_DENIED — The key lacks the method's permission.
  • RESOURCE_NOT_FOUND — The named Resource does not exist or is not visible.
  • INVALID_STATE — The Resource is in a state that forbids the call.
  • DEVICE_LOST — The Android device is no longer online. The lease retains its machine and files until release or expiry. No new device action or execution was dispatched.
  • NOT_FOUND — No method is served at this path.
  • UNIMPLEMENTED — The path or method is not served (yet) at this version.

Every error arrives in the body Errors describes.

Examples

curl -X POST "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/leases/lease:installApp" \
  -H "Authorization: Bearer $SYLPHX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'