Application Version

Prepare application version deployment

Validates a manual deployment and returns the gateway publish payload.

post/v2/application/{organization}/{project}/{application}/version-deploy/prepare

Request

  • Base URL: https://api.zephyr-cloud.io
  • URL: https://api.zephyr-cloud.io/v2/application/{organization}/{project}/{application}/version-deploy/prepare
  • Auth: HTTP bearer

Path parameters

organizationstring required

Organization name (slug)

Example:zephyr-cloud
projectstring required

Project name (slug)

Example:main-app
applicationstring required

Application name (slug)

Example:web-dashboard

Query parameters

is-rollback'true' | 'false'

Whether this is a rollback deployment

Example:true

Request body

idstring required

Version ID

deployTarget'environment' | 'tag' required

Target type for deployment

deployTargetIdstring required

Target ID (environment or tag ID)

snapshot_idstring required

Snapshot ID of the version to deploy

lockTagboolean

Lock the tag after deployment (only applies when deployTarget is "tag")

lockEnvironmentboolean

Lock the environment after deployment (only applies when deployTarget is "environment")

Response

Deployment prepared

Changes

No recorded changes to this operation across all 1 revision of this API.