Description
Creates a new release for a project. A release locks in the project's deployment plan (steps), the chosen package versions, and the project channel - everything needed to redeploy the same thing later.
If version is omitted, the server proposes the next version using the project's release versioning rules. If packageVersions is omitted, the latest version of every project package is selected by default.
If channelName is omitted the project's default channel is used (unless ignoreDefaultChannel = true).
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
projectId |
body | string | yes | ID of the project to create the release for. |
channelName |
body | string | no | Channel name to bind the release to. Defaults to the project's default channel. |
ignoreDefaultChannel |
body | boolean | no | Set to true to skip the project's default channel when channelName is omitted. |
version |
body | string | no | Explicit SemVer version. Defaults to the next proposed version. |
notes |
body | string | no | Free-form release notes. |
packageVersions |
body | object | no | Map of packageId -> version to pin specific package versions. |
Errors
| Status | Meaning |
|---|---|
400 |
Invalid projectId, invalid channelName, or pinned packages with versions that don't exist. |
401 |
Missing or invalid Basic auth credentials, or the service account lacks the required role. |
400 |
Validation failed - the response includes errorcode = InvalidParameter and (where applicable) a validationErrors map. |