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 deployment.

Info

NOTE: Deployments 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/deployments/<id>

where:

ParameterDescription
<id>Internal identifier for the deployment

Request URI - Example:

Code Block
/v3/deployments/2

Request Body: Example - Modify the deployment name

Code Block
{
    "name": "New Deployment Name"
}

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 deployment, see API Deployments Get v3.