Get deployment template

Retrieves a deployment template by id.

Request

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

Path parameters

Name Type Required Description

template_id

string

Y

The identifier for the deployment template.

Query parameters

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

200

(DeploymentTemplateInfo) The deployment template was found and returned successfully.

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

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