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/platform/configuration/templates/deployments
Query parameters
editName | Type | Required | Description |
---|---|---|---|
|
|
N |
If cluster is specified populates cluster_template in the response, if deployment is specified populates deployment_template in the response |
|
|
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. |
|
|
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[
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
-
Request example
editcurl -XGET https://{{hostname}}/api/v1/platform/configuration/templates/deployments \ -H "Authorization: ApiKey $ECE_API_KEY"