Get a deployment

GET

/v1/apps/{appName}/deployments/{deploymentName}

const url = 'https://api.aetherpush.com/v1/apps/example/deployments/example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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/apps/example/deployments/example \
  --header 'Authorization: Bearer <token>'

Returns deployment metadata including the current package.

Authorizations

accessKeyAuth
apiKeyAuth
read

Parameters

Path Parameters

appName

required

string

deploymentName

required

string

Responses

200

Deployment details.

application/json

object

deployment

required

object

name

required

string

<= 255 characters

key

Deployment key consumed by the React Native SDK at runtime. Replaced with “(hidden)” for accounts without the deploymentKeys.read capability.

string

package

object

appVersion

string

blobUrl

required

Signed URL to download the package bundle.

string format: uri

description

string

diffPackageMap

Map of source package hash to diff blob info.

object

key

additional properties

object

size

required

integer format: int64

url

required

string format: uri

isDisabled

boolean

isMandatory

boolean

label

string

manifestBlobUrl

Signed URL to the package manifest (file hash map).

string format: uri

originalDeployment

Set when releaseMethod is Promote.

string

originalLabel

Set when releaseMethod is Promote or Rollback.

string

packageHash

string

releasedBy

Account email of the releaser.

string format: email

releaseMethod

string

Allowed values: Upload Promote Rollback

rollout

integer | null

>= 1 <= 100

size

required

Package size in bytes.

integer format: int64

uploadTime

Unix timestamp in milliseconds.

integer format: int64

Example

{
  "deployment": {
    "name": "Production",
    "key": "AbCdEf1234567890",
    "package": {
      "appVersion": "1.0.0",
      "label": "v3",
      "releaseMethod": "Upload"
    }
  }
}

401

Unauthenticated, or not a collaborator.

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

404

App or deployment not found.

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