# Get deployment templates

**GET /deployments/templates**

Retrieves all deployment templates.


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



## Parameters


### Query parameters
- **metadata** (string)
  An optional key/value pair in the form of (key:value) that will act as a filter and exclude any templates that do not have a matching metadata item associated.
- **show_instance_configurations** (boolean)
  If true, will return details for each instance configuration referenced by the template.
- **show_max_zones** (boolean)
  If true, will populate the max_zones field in the instance configurations. Only relevant if show_instance_configurations=true.
- **stack_version** (string)
  If present, it will cause the returned deployment templates to be adapted to return only the elements allowed in that version.
- **hide_deprecated** (boolean)
  If true, templates flagged as deprecated will NOT be returned.
- **region** (string)
  Region of the deployment templates


## Responses
### 200
The deployment templates were returned successfully.

#### Body: application/json (array[object])
- **id** (string)
  The unique identifier for the template.
- **name** (string)
  A human readable name for the template.
- **description** (string)
  An optional description for the template.
- **deployment_template** (object)
  A request for creating a new Deployment consisting of multiple clusters
- **system_owned** (boolean)
  Whether or not if this is system owned template.
- **source** (object)
  A container for information about the source of a change.
- **metadata** (array[object])
  Optional arbitrary metadata to associate with this template.
- **instance_configurations** (array[object])
  List of instance configurations used in the cluster template.
- **order** (integer(int32))
  Determines the order in which this template should be returned when listed. Templates are returned in ascending order. If not specified, then the template willbe appended to the end of the list.
- **min_version** (string)
  Minimum stack version required by this template, if any.
- **template_category_id** (string)
  Provider and version agnostic template identifier used for grouping related template types.
- **kibana_deeplink** (array[object])
  The Kibana Deeplink for this type of deployment.

### 400
The requested region was not found. (code: `templates.region_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

### 401
The user is not authorized to access requested region. (code: `templates.region_not_allowed`)
#### 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)