Amazon API Gateway REST API Reference


Changes information about the deployment resource.

HTTP Request

PATCH /restapis/<restapi_id>/deployments/<deployment_id>

Request Body

  "patchOperations" : [ {
    "op" : "String",
    "path" : "String",
    "value" : "String",
    "from" : "String"
  } ]

Request Body Fields

The request accepts the following fields in JSON format.

  • patchOperations
  • A list of update operations to be applied to the specified resource and in the order specified in this list.

    • op
    • An update operation to be performed with this PATCH request. The valid value can be add, remove, replace or copy. Not all valid operations are supported for a given resource. Support of the operations depends on specific operational contexts. Attempts to apply an unsupported operation on a resource will return an error message.

    • path
    • The op operation's target, as identified by a JSON Pointer value that references a location within the targeted resource. For example, if the target resource has an updateable property of {"name":"value"}, the path for this property is /name. If the name property value is a JSON object (e.g., {"name": {"child/name": "child-value"}}), the path for the child/name property will be /name/child~1name. Any slash ("/") character appearing in path names must be escaped with "~1", as shown in the example above. Each op operation can have only one path associated with it.

    • value
    • The new target value of the update operation. It is applicable for the add or replace operation. When using AWS CLI to update a property of a JSON value, enclose the JSON object with a pair of single quotes in a Linux shell, e.g., '{"a": ...}'. In a Windows shell, see Using JSON for Parameters.

    • from
    • The copy update operation's source as identified by a JSON-Pointer value referencing the location within the targeted resource to copy the value from. For example, to promote a canary deployment, you copy the canary deployment ID to the affiliated deployment ID by calling a PATCH request on a Stage resource with "op":"copy", "from":"/canarySettings/deploymentId" and "path":"/deploymentId".




The following table shows the supported and unsupported op operations for updateable Deployment properties of the specified path values.

path op:add op:replace op:remove op:copy
/description Not supported Supported Not supported Not supported

Example: Update a deployment description


PATCH /restapis/fugvjdxtri/deployments/dzacq7 HTTP/1.1
Content-Type: application/json
X-Amz-Date: 20160603T192159Z
Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160603/us-east-1/apigateway/aws4_request, SignedHeaders=content-length;content-type;host;x-amz-date, Signature={sig4_hash}

  "patchOperations" : [ {
    "op" : "replace",
    "path" : "/description",
    "value" : "Updated first deployment"
  } ]

The successful response returns the 200 OK status and a payload as follows:

  "_links": {
    "curies": {
      "href": "{rel}.html&quot;,
      "name": "deployment",
      "templated": true
    "self": {
      "href": "/restapis/fugvjdxtri/deployments/dzacq7"
    "deployment:delete": {
      "href": "/restapis/fugvjdxtri/deployments/dzacq7"
    "deployment:stages": {
      "href": "/restapis/fugvjdxtri/stages?deployment_id=dzacq7"
    "deployment:update": {
      "href": "/restapis/fugvjdxtri/deployments/dzacq7"
  "createdDate": "2016-06-03T17:56:06Z",
  "description": "Updated first deployment",
  "id": "dzacq7"

See Also