Skip to content

Report install/deploy result for a release (canonical)

POST
/v1/public/aether/report_status/deploy
curl --request POST \
--url https://api.aetherpush.com/v1/public/aether/report_status/deploy \
--header 'Content-Type: application/json' \
--data '{ "deployment_key": "example", "app_version": "example", "client_unique_id": "example", "label": "example", "status": "DeploymentSucceeded", "previous_deployment_key": "example", "previous_label_or_app_version": "example" }'

Canonical Aether acquisition endpoint. Successor to /v0.1/public/codepush/report_status/deploy with identical semantics. Accepts both snake_case and camelCase body keys.

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

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"
}

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"
}