API Reference
  1. Mercury API
  2. App

Check whether the calling app build needs updating

get
https://example.com/v1/app/update-check

Unauthenticated, pure-function-of-the-query-tuple verdict for whether the caller's app build should be nagged or blocked. Called at bootstrap, before login. Returns {action: "none"} when no policy is configured for the caller's platform.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
enum
required

Mobile platforms the update-check gate is configured per.

Allowed:
string
required
^\d{1,9}\.\d{1,9}\.\d{1,9}$

Caller's app version, e.g. '1.4.2'.

string
required
^\d{1,9}(\.\d{1,9}){0,3}$

Caller's OS version. iOS: one to four dotted numeric segments (e.g. '17.5.1'). Android: a single API-level integer (e.g. '34'). OpenAPI cannot express the platform split; Android dotted values are rejected at runtime with 422.

Caller's build number. Advisory only; never validated.

Responses

422

Malformed platform, version, or osVersion

429

Per-IP rate limit exceeded

Updated 18 days ago

Did this page help you?
Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 18 days ago

Did this page help you?