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 Create deployment template »
Elastic Docs ›Elastic Cloud Enterprise Reference [2.4] ›RESTful API ›API reference ›Templates - Deployments

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

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.

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

Request example

edit
curl -XGET {{hostname}}/api/v1/platform/configuration/templates/deployments \
-H "Authorization: ApiKey $ECE_API_KEY"
« Templates - Deployments Create deployment template »