Update the specified release.

NOTE: Releases pertain to Production instances of the . For more information, see Overview of Deployment Manager.

Version: v3

Required Permissions

Request

Request Type: PATCH

Endpoint:

/v3/releases/<id>

where:

ParameterDescription
<id>Internal identifier for the release

Request URI - Example:

/v3/releases/2

Request Body: Example - Activate the release

You can use the following example to make the current release the active one for the deployment.

NOTE: You can have only one active release per deployment. If this release is made active as part of this execution, the currently active release is made inactive.

Tip: You can use this endpoint to deactivate a release, which prevents its jobs from being run. If there is no active release for the deployment, no jobs are run via the deployment job run endpoint. See API Deployments Run v3.

{
    "active": true
}

Response

Response Status Code - Success: 200 - OK

Response Body Example:

{
    "id": 2,
    "updatedBy": 1,
    "updatedAt": "2017-10-13T00:06:12.147Z"
}

Reference

For more information on the properties of a release, see API Releases Get v3.