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.
Get deployment templates
editGet deployment templates
editRetrieves all deployment templates.
Request
editGET /api/v1/deployments/templates
Query parameters
editName | Type | Required | Description |
---|---|---|---|
|
|
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. |
|
|
Y |
Region of the deployment templates |
|
|
N |
If true, templates flagged as hidden will be returned. |
|
|
N |
If true, will return details for each instance configuration referenced by the template. |
|
|
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[
DeploymentTemplateInfoV2
]
) The deployment templates were returned successfully. -
400
-
(
BasicFailedReply
) The requested region was not found. (code:templates.region_not_found
)Headers
-
x-cloud-error-codes
(string
; allowed values: [templates.region_not_found
]) - The error codes associated with the response
-
-
401
-
(
BasicFailedReply
) The user is not authorized to access requested region. (code:templates.region_not_allowed
)Headers
-
x-cloud-error-codes
(string
; allowed values: [templates.region_not_allowed
]) - 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
editcurl -XGET https://{{hostname}}/api/v1/deployments/templates \ -H "Authorization: ApiKey $ECE_API_KEY"