It is time to say goodbye: This version of Elastic Cloud Enterprise has reached end-of-life (EOL) and is no longer supported.

The documentation for this version is no longer being maintained. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.

« Templates - Deployments - Legacy Create deployment template »

› › › ›

Get deployment templates

edit

Get deployment templates

edit

Retrieves all deployment templates.

Request

edit

GET /api/v1/platform/configuration/templates/deployments

Query parameters

edit

Name	Type	Required	Description
`format`	`string`; allowed values: [`cluster`, `deployment`]; default: `"cluster"`	N	If cluster is specified populates cluster_template in the response, if deployment is specified populates deployment_template in the response
`metadata`	`string`	N	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_hidden`	`boolean`; default: `false`	N	If true, templates flagged as hidden will be returned.
`show_instance_configurations`	`boolean`; default: `false`	N	If true, will return details for each instance configuration referenced by the template.
`stack_version`	`string`	N	If present, it will cause the returned deployment templates to be adapted to return only the elements allowed in that version.

Responses

edit

200

(array[DeploymentTemplateInfo]) The deployment templates were returned successfully.

400

(BasicFailedReply) The template is not compatible with the [cluster] format. (code: deployment.migration_invalid)

Headers

x-cloud-error-codes (string; allowed values: [deployment.migration_invalid]): The error codes associated with the response

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

edit

curl -XGET https://{{hostname}}/api/v1/platform/configuration/templates/deployments \
-H "Authorization: ApiKey $ECE_API_KEY"

« Templates - Deployments - Legacy Create deployment template »