Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin

D toc

Update the specified release.

Info

NOTE: Releases pertain to Production instances of the

D s platform
rtrue
. For more information, see Overview of Deployment Management.

Version: v3

Required Permissions

D s api auth

Request

Request Type: PATCH

Endpoint:

Code Block
/v3/releases/<id>

where:

ParameterDescription
<id>Internal identifier for the release

Request URI - Example:

Code Block
/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.

Info

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

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.

Code Block
{
    "active": true
}

Response

Response Status Code - Success: 200 - OK

Response Body Example:

Code Block
{
    "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.