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.
Migrate plan
editMigrate plan
editDEPRECATED (Scheduled to be removed in the next major version): Migrates the configuration of the Elasticsearch cluster to a different template.
Request
editPOST /api/v1/clusters/elasticsearch/{cluster_id}/plan/_migrate
Path parameters
editName | Type | Required | Description |
---|---|---|---|
|
|
Y |
The Elasticsearch cluster identifier. |
Query parameters
editName | Type | Required | Description |
---|---|---|---|
|
|
Y |
The ID of the deployment template to migrate to |
|
|
N |
When true, validates the cluster definition, but does not perform the update |
Responses
edit-
200
-
(
ClusterPlanMigrationResponse
) The current cluster plan migrated to the specified deployment template. -
202
-
(
ClusterPlanMigrationResponse
) The plan definition was valid and the updated plan is in progress -
400
-
(
BasicFailedReply
) Migrating to the specified template would lead to an invalid or unsupported cluster definition. (code:clusters.cluster_invalid_plan
)Headers
-
x-cloud-error-codes
(string
; allowed values: [clusters.cluster_invalid_plan
]) - The error codes associated with the response
-
-
404
-
(
BasicFailedReply
) The cluster specified by {cluster_id} cannot be found. (code:clusters.cluster_not_found
)Headers
-
x-cloud-error-codes
(string
; allowed values: [clusters.cluster_not_found
]) - The error codes associated with the response
-
-
412
-
(
BasicFailedReply
) There is not currently applied plan - eg the cluster has not finished provisioning, or the provisioning failed. (code:clusters.cluster_plan_state_error
)Headers
-
x-cloud-error-codes
(string
; allowed values: [clusters.cluster_plan_state_error
]) - The error codes associated with the response
-
-
449
-
(
BasicFailedReply
) Elevated permissions are required. (code:root.unauthorized.rbac.elevated_permissions_required
)Headers
-
x-cloud-error-codes
(string
; allowed values: [root.unauthorized.rbac.elevated_permissions_required
]) - The error codes associated with the response
-
Request example
editcurl -XPOST https://{{hostname}}/api/v1/clusters/elasticsearch/{cluster_id}/plan/_migrate \ -H "Authorization: ApiKey $ECE_API_KEY"