Builds

Deploy version

Deploys a specific version to an environment or tag

post/v2/builds/{organization}/{project}/{application}/versions/{version}/deploy

Request

  • Base URL: https://api.zephyr-cloud.io
  • URL: https://api.zephyr-cloud.io/v2/builds/{organization}/{project}/{application}/versions/{version}/deploy
  • 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
versionstring required

Version identifier (version name or snapshot ID)

Example:1.0.0

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 initiated successfully

valueboolean required

Changes

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