Check whether an update is available for the client (canonical)

GET

/v1/public/aether/update_check

const url = 'https://api.aetherpush.com/v1/public/aether/update_check?deployment_key=example&app_version=example&is_companion=true';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.aetherpush.com/v1/public/aether/update_check?deployment_key=example&app_version=example&is_companion=true'

Canonical Aether acquisition endpoint. Called by the React Native SDK at launch to determine if a newer JS bundle is available. Response fields use snake_case, wrapped in update_info. Successor to /v0.1/public/codepush/update_check with an identical payload.

Parameters

Query Parameters

deployment_key

required

string

Deployment key (provided in app bundle config).

app_version

required

string

Binary version of the installed app (semver).

package_hash

string

client_unique_id

string

is_companion

string

Allowed values: true false

label

string

Responses

200

Update info (may indicate no update available).

application/json

Wrapper response for update_check. The actual update info lives under update_info.

object

update_info

required

Response shape consumed by the React Native SDK acquisition endpoint. Field names use snake_case for backward compatibility with react-native-code-push. Returned wrapped in { "update_info": ... }.

object

app_version

string

target_binary_range

Semver range of binary versions this update targets.

string

description

string

download_url

string format: uri

is_available

required

boolean

is_mandatory

boolean

label

string

package_hash

string

package_size

integer format: int64

should_run_binary_version

boolean

update_app_version

boolean

Example

{
  "update_info": {
    "app_version": "1.0.0",
    "target_binary_range": "1.0.0"
  }
}

400

Invalid deployment_key or app_version.

application/json

object

error

required

Human-readable error message.

string

requestId

Unique identifier for the request, also exposed as the X-Request-Id response header.

string

Example

{
  "error": "The requested resource was not found.",
  "requestId": "req_abc123"
}