Description
Promotes a project's release without needing to know its release ID. If version is omitted, the highest existing version is used. The deployment payload is the same as /api/release/deploy aside from looking up the release by project+version.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
projectId |
body | string | yes | ID of the project to promote. |
version |
body | string | no | Specific version to promote. Defaults to the highest existing version. |
environmentName |
body | string | no | Single environment to deploy to. |
phaseName |
body | string | no | Promote to every environment in the given lifecycle phase. |
environments |
body | array | no | Per-environment machine rules - same shape as /api/release/deploy. |
redownloadPackages |
body | boolean | no | Force agents to redownload packages. |
deploymentDateUnixMillis |
body | number | no | Schedule the deployment for a future time (UTC unix millis). |
excludeStepNames |
body | array<string> | no | Skip these step names from the deployment. |
Errors
| Status | Meaning |
|---|---|
400 |
Invalid projectId, no release found to promote, no matching environments, or validation failure. |
409 |
Resource usage limit exceeded. |
401 |
Missing or invalid Basic auth credentials, or the service account lacks the required role. |