Skip to content
AetherAether Docs

Report install/deploy result for a release

Deprecated
POST
/v0.1/public/codepush/report_status/deploy
curl --request POST \
  --url https://api.aetherpush.com/v0.1/public/codepush/report_status/deploy \
  --header 'Content-Type: application/json' \
  --data '{ "deployment_key": "AbCdEf1234567890", "app_version": "1.0.0", "client_unique_id": "8f4e2c1a-9b3d-4f5e-a6c7-d8e9f0a1b2c3", "label": "v3", "status": "DeploymentSucceeded" }'

Called by the React Native SDK after attempting to install a JS bundle update. Used to compute install success/failure metrics and active-app counts per release.

The server is permissive about field shape — both snake_case and camelCase keys are accepted. Modern SDKs (>= 1.5.2-beta) include idempotency-aware logic that suppresses duplicate success reports.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json

Body shape for report_status/deploy. Reports the result of a client attempting to install a package. Most fields are optional; the SDK populates them based on what it knows. The server accepts both camelCase (deploymentKey) and snake_case (deployment_key) field names; snake_case is the canonical form.

object
deployment_key
required
string
app_version
required
string
client_unique_id
string
label
string
status
string
Allowed values: DeploymentSucceeded DeploymentFailed
previous_deployment_key
string
previous_label_or_app_version
string
key
additional properties
any
Example
{
  "deployment_key": "AbCdEf1234567890",
  "app_version": "1.0.0",
  "client_unique_id": "8f4e2c1a-9b3d-4f5e-a6c7-d8e9f0a1b2c3",
  "label": "v3",
  "status": "DeploymentSucceeded"
}

Responses

Section titled “Responses”

200

Section titled “200”

Status accepted.

Media typeapplication/json

Lightweight acknowledgment for status reports. Sent in some legacy code paths.

object
status
string
message
string
key
additional properties
any
Examplegenerated
{
  "status": "example",
  "message": "example"
}

Headers

Section titled “Headers”
Deprecation
string

Present on legacy acquisition endpoints. Signals the endpoint is deprecated in favor of its canonical /v1/public/aether/* successor. The value is the string true.

Example
true
Link
string

RFC 8288 link header with two link values: the canonical successor endpoint via rel=“successor-version”, and the CodePush migration guide via rel=“deprecation”.

Example
</v1/public/aether/update_check>; rel="successor-version", <https://docs.aetherpush.com/migration/codepush/>; rel="deprecation"

400

Section titled “400”

Missing required fields, or invalid status value.

Media typeapplication/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"
}