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.

« Update Deployment Restores a shutdown Deployment »

› › › ›

Build Migrate Deployment Template request

edit

Build Migrate Deployment Template request

edit

Returns a deployment update request that would transform this deployment from its template to the provided one.

Request

edit

POST /api/v1/deployments/{deployment_id}/_migrate

Path parameters

edit

Name	Type	Required	Description
`deployment_id`	`string`	Y	Identifier for the Deployment

Query parameters

edit

Name	Type	Required	Description
`template`	`string`	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

edit

curl -XPOST https://{{hostname}}/api/v1/deployments/{deployment_id}/_migrate \
-H "Authorization: ApiKey $ECE_API_KEY"

« Update Deployment Restores a shutdown Deployment »