Deployments - Templates
editDeployments - Templates
editGet deployment templates
editRetrieves all deployment templates.
Request
editGET /api/v1/deployments/templates
Query parameters
editName | Type | Required | Description |
---|---|---|---|
|
|
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. |
|
|
Y |
Region of the deployment templates |
|
|
N |
If true, will return details for each instance configuration referenced by the template. |
|
|
N |
If true, will populate the max_zones field in the instance configurations. Only relevant if show_instance_configurations=true. |
|
|
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[
DeploymentTemplateInfoV2
]
)The deployment templates were returned successfully.
-
400
-
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
-
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 example
editcurl -XGET https://api.elastic-cloud.com/api/v1/deployments/templates \ -H "Authorization: ApiKey $EC_API_KEY"
Get deployment template
editRetrieves a deployment template by id.
Request
editGET /api/v1/deployments/templates/{template_id}
Path parameters
editName | Type | Required | Description |
---|---|---|---|
|
|
Y |
The identifier for the deployment template. |
Query parameters
editName | Type | Required | Description |
---|---|---|---|
|
|
Y |
Region of the deployment template |
|
|
N |
If true, will return details for each instance configuration referenced by the template. |
|
|
N |
If true, will populate the max_zones field in the instance configurations. Only relevant if show_instance_configurations=true. |
|
|
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
-
The deployment template was found and returned successfully.
-
400
-
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
-
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
-
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 example
editcurl -XGET https://api.elastic-cloud.com/api/v1/deployments/templates/{template_id} \ -H "Authorization: ApiKey $EC_API_KEY"