# Get Deployment

**GET /deployments/{deployment_id}**

Retrieves information about 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
- **show_security** (boolean)
  Whether to include the Elasticsearch 2.x security information in the response - can be large per cluster and also include credentials
- **show_metadata** (boolean)
  Whether to include the full cluster metadata in the response - can be large per cluster and also include credentials
- **show_plans** (boolean)
  Whether to include the full current and pending plan information in the response - can be large per cluster
- **show_plan_logs** (boolean)
  Whether to include with the current and pending plan information the attempt log - can be very large per cluster
- **show_plan_history** (boolean)
  Whether to include the plan history with the current and pending plan information. The results can be very large per cluster.
   By default, if a given resource kind (e.g. Elasticsearch, Kibana, etc.) has more than 100 plans
   (which should be very rare, most likely caused by a bug) only 100 plans are returned for the given resource type:
   The first 10 plans, and the last 90 plans for that resource type.
   If ALL of the plans are desired, pass the `force_all_plan_history` parameter with a value of `true`.
- **show_plan_defaults** (boolean)
  If showing plans, whether to show values that are left at their default value (less readable but more informative)
- **convert_legacy_plans** (boolean)
  If showing plans, whether to leave pre-2.0.0 plans in their legacy format (the default), or whether to update them to 2.0.x+ format (if 'true')
- **show_system_alerts** (integer)
  Number of system alerts (such as forced restarts due to memory limits) to be included in the response - can be large per cluster. Negative numbers or 0 will not return field.
- **show_settings** (boolean)
  Whether to show cluster settings in the response.
- **show_instance_metrics** (boolean)
  Whether to show resources instance metrics in the response.
- **show_instance_configurations** (boolean)
  If true, will return details for each instance configuration referenced by the deployment.
- **enrich_with_template** (boolean)
  If showing plans, whether to enrich the plan by including the missing elements from the deployment template it is based on
- **force_all_plan_history** (boolean)
  Force show the entire plan history no matter how long.
   As noted in the `show_plan_history` parameter description, by default, a maximum of 100 plans are shown per resource. 
   If `true`, this parameter overrides the default, and ALL plans are returned.
   Use with care as the plan history can be VERY large. Consider pairing with `show_plan_logs=false`.
   
- **clear_transient** (boolean)
  If set (defaults to false) then removes the transient section from all child resources, making it safe to reapply via an update


## Responses
### 200
The Deployment info response
#### 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)
  A randomly-generated id of this Deployment
- **name** (string)
  The name of this deployment
- **alias** (string)
  A user-defined deployment alias for user-friendly resource URLs
- **healthy** (boolean)
  Whether the deployment is overall healthy or not (one or more of the resource info subsections will have healthy: false)
- **resources** (object)
  Describes a resource belonging to a Deployment
- **settings** (object)
  Additional configuration about the current deployment object.
- **metadata** (object)
  Additional information about the current deployment object.
- **observability** (object)
  Observability information for a deployment
- **instance_configurations** (array[object])
  List of instance configurations used in the deployment.

### 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)