Get deployment template

IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

Retrieves a deployment template by id.

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

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

Name	Type	Required	Description
`region`	`string`	Y	Region of the deployment template
`show_instance_configurations`	`boolean`; default: `true`	N	If true, will return details for each instance configuration referenced by the template.
`show_max_zones`	`boolean`; default: `false`	N	If true, will populate the max_zones field in the instance configurations. Only relevant if show_instance_configurations=true.
`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.

200

(DeploymentTemplateInfoV2)

The deployment template was found and returned successfully.

400

(BasicFailedReply)

The requested region is not supported. (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

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

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