v1

latestOpenAPI 3.0.32026-07-17502149.6 KB

Acquisition

Check for updates

Client SDK endpoint to check for available updates. This endpoint does not require authentication - it uses deployment keys.

get/updateCheck

Query parameters

deploymentKeystring required

Deployment key from app configuration

appVersionstring required

Current app version (semver format)

packageHashstring

Hash of currently installed package

labelstring

Label of currently installed release

clientUniqueIdstring

Unique device/client identifier for rollout targeting

isCompanionboolean

Whether this is a companion app request

Response

Update check response

Example response

{
  "updateInfo": {
    "appVersion": "1.0.0",
    "description": "Bug fixes and performance improvements",
    "rollout": 50,
    "label": "v23"
  }
}