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

edit

Migrate plan

edit

Migrates the configuration of the Elasticsearch cluster to a different template.

Request

edit

POST /api/v1/clusters/elasticsearch/{cluster_id}/plan/_migrate

Path parameters

edit

Name	Type	Required	Description
`cluster_id`	`string`	Y	The Elasticsearch cluster identifier.

Query parameters

edit

Name	Type	Required	Description
`template`	`string`	Y	The ID of the deployment template to migrate to
`validate_only`	`boolean`; default: `false`	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)
404: (BasicFailedReply) The cluster specified by {cluster_id} cannot be found. (code: clusters.cluster_not_found)
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)
449: (BasicFailedReply) Elevated permissions are required. (code: root.unauthorized.rbac.elevated_permissions_required)

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

edit

curl -XPOST {{hostname}}/api/v1/clusters/elasticsearch/{cluster_id}/plan/_migrate \
-u $CLOUD_USER:$CLOUD_KEY

« Update plan Get plan activity »