Update a deploy alias

POST

/v1/deploys/{deployId}/aliases/{alias}

curl --request POST \
  --url https://api.presscloud.example/v1/deploys/example/aliases/preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "deployVersionId": "example" }'

Points a deploy alias such as preview or production to a specific deploy version.

Authorizations

• bearerAuth

Parameters

Path Parameters

deployId

required

string

>= 1 characters

alias

required

string

Allowed values: preview production

Request Body ^required

Media type application/json

object

deployVersionId

required

string

>= 1 characters

Example ^generated

{
  "deployVersionId": "example"
}

Responses

200

Alias updated.

Media type application/json

object

deployId

required

string

alias

required

string

Allowed values: preview production

deployVersionId

required

string

updatedAt

required

integer

Example

{
  "alias": "preview"
}

400

Invalid request payload or parameters.

Media type application/json

object

error

required

string

message

required

string

Example ^generated

{
  "error": "example",
  "message": "example"
}

404

Requested resource was not found.

Media type application/json

object

error

required

string

message

required

string

Example ^generated

{
  "error": "example",
  "message": "example"
}