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.

« Delete deployment template Set deployment template »

› › › ›

Get deployment template

edit

Get deployment template

edit

Retrieves a deployment template by id.

Request

edit

GET /api/v1/platform/configuration/templates/deployments/{template_id}

Path parameters

edit

Name	Type	Required	Description
`template_id`	`string`	Y	The identifier for the deployment template.

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
`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 template to be adapted to return only the elements allowed in that version.

Responses

edit

200

(DeploymentTemplateInfo) The deployment template was found and 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

404

(BasicFailedReply) The deployment template specified by {template_id} cannot be found. (code: templates.template_not_found)

Headers

x-cloud-error-codes (string; allowed values: [templates.template_not_found]): 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/{template_id} \
-H "Authorization: ApiKey $ECE_API_KEY"

« Delete deployment template Set deployment template »