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.
Build Migrate Deployment Template request
editBuild Migrate Deployment Template request
editReturns a deployment update request that would transform this deployment from its template to the provided one.
Request
editPOST /api/v1/deployments/{deployment_id}/_migrate
Path parameters
editName | Type | Required | Description |
---|---|---|---|
|
|
Y |
Identifier for the Deployment |
Query parameters
editName | Type | Required | Description |
---|---|---|---|
|
|
Y |
The ID of the deployment template to migrate to |
Responses
edit-
200
-
(
DeploymentTemplateMigrateResponse
) The request was valid and the deployment can be migrated to the template with the provided id. -
400
-
(
BasicFailedReply
) The deployment cannot be successfully migrated to the template with the provided id. -
401
-
(
BasicFailedReply
) You are not authorized to perform this action. -
404
-
(
BasicFailedReply
) The Deployment specified by {deployment_id} cannot be found. (code:deployments.deployment_not_found
)Headers
-
x-cloud-error-codes
(string
; allowed values: [deployments.deployment_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
editcurl -XPOST https://{{hostname}}/api/v1/deployments/{deployment_id}/_migrate \ -H "Authorization: ApiKey $ECE_API_KEY"