Rename a deployment

PATCH

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

curl --request PATCH \
  --url https://api.aetherpush.com/v1/apps/example/deployments/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "Production-V2" }'

• Production
• Staging
• Local development

Updates the deployment’s name. Requires the deployments.manage permission (Owner or Admin) to rename a deployment. Note that renaming changes the resource path — clients must update their references.

Authorizations

• accessKeyAuth
• apiKeyAuth
  apps

Parameters

Path Parameters

appName

required

string

deploymentName

required

string

Request Body^required

Media typeapplication/json

object

name

string

>= 1 characters <= 255 characters

Example

{
  "name": "Production-V2"
}

Responses

200

Deployment renamed.

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

400

Validation error.

Media typeapplication/json

One of:

object

object

error

required

Human-readable error message.

string

requestId

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

string

object

object

error

required

string

errors

required

Array<object>

>= 1 items

object

field

required

string

message

required

string

requestId

string

Example

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

403

Insufficient permissions (deployments.manage required).

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

404

App or deployment not found.

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

409

Another deployment with that name already exists.

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