# Update Deployment

**PUT /deployments/{deployment_id}**

Updates a Deployment.


## Servers
- https://api.elastic-cloud.com/api/v1: https://api.elastic-cloud.com/api/v1 ()



## Parameters

### Path parameters
- **deployment_id** (string)
  Identifier for the Deployment

### Query parameters
- **hide_pruned_orphans** (boolean)
  Whether or not to hide orphaned resources that were shut down (relevant if prune on the request is true)
- **skip_snapshot** (boolean)
  Whether or not to skip snapshots before shutting down orphaned resources (relevant if prune on the request is true)
- **validate_only** (boolean)
  If true, will just validate the Deployment definition but will not perform the update
- **version** (string)
  If specified then checks for conflicts against the version stored in the persistent store (returned in 'x-cloud-resource-version' of the GET request)

### Body: application/json (object)
The deployment definition
- **name** (string)
  A new name for the deployment, otherwise stays the same.
- **prune_orphans** (boolean)
  Whether or not to prune orphan resources that are no longer mentioned in this request. Note that resourcesare tracked by ref_id, and if a resource's ref_id is changed, any previous running resources created with that previousref_id are considered to be orphaned as well.
- **resources** (object)
  Describes the Deployment resource updates
- **settings** (object)
  Additional configuration for the new deployment object.
- **metadata** (object)
  Additional information about the current deployment object.
- **alias** (string)
  A user-defined alias to use in place of Cluster IDs for user-friendly URLs


## Responses
### 200
The request was valid and the deployment was updated.
#### Headers
- **x-cloud-resource-version** (string)
  The resource version, which is used to avoid update conflicts with concurrent operations
- **x-cloud-resource-created** (string)
  The date-time when the resource was created (ISO format relative to UTC)
- **x-cloud-resource-last-modified** (string)
  The date-time when the resource was last modified (ISO format relative to UTC)

#### Body: application/json (object)
- **id** (string)
  The id of the deployment
- **name** (string)
  The name of the deployment
- **alias** (string)
  A user-defined alias to use in place of ResourceIds for user-friendly resource URLs
- **resources** (array[object])
  List of resources that are part of the deployment after the update operation.
- **shutdown_resources** (object)
  Details about orphaned resources.
- **diagnostics** (object)
  Describes the diagnostics for a given Deployment-modifying payload
- **settings** (object)
  Additional configuration about the current deployment object.

### 400
The deployment request had errors.

#### Body: application/json (object)
- **errors** (array[object])
  A list of errors that occurred in the failing request

### 401
You are not authorized to perform this action.

#### Body: application/json (object)
- **errors** (array[object])
  A list of errors that occurred in the failing request

### 404
The Deployment specified by {deployment_id} cannot be found. (code: `deployments.deployment_not_found`)
#### Headers
- **x-cloud-error-codes** (string)
  The error codes associated with the response

#### Body: application/json (object)
- **errors** (array[object])
  A list of errors that occurred in the failing request


[Powered by Bump.sh](https://bump.sh)