Deployments - Templates | Elasticsearch Service Documentation

› › ›

« Deployments - Extensions Deployments - Traffic Filter - Associations »

Deployments - Templatesedit

Get deployment templatesedit

Retrieves all deployment templates.

Requestedit

GET /api/v1/deployments/templates

Query parametersedit

Name	Type	Required	Description
`metadata`	`string`	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.
`region`	`string`	Y	Region of the deployment templates
`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 templates to be adapted to return only the elements allowed in that version.

Responsesedit

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

Request exampleedit

curl -XGET https://api.elastic-cloud.com/api/v1/deployments/templates \
-H "Authorization: ApiKey $EC_API_KEY"

Get deployment templateedit

Retrieves a deployment template by id.

Requestedit

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

Path parametersedit

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

Query parametersedit

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.

Responsesedit

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

Request exampleedit

curl -XGET https://api.elastic-cloud.com/api/v1/deployments/templates/{template_id} \
-H "Authorization: ApiKey $EC_API_KEY"

« Deployments - Extensions Deployments - Traffic Filter - Associations »