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

Identifier for the Elasticsearch cluster

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

(ElasticsearchClusterPlan) The current cluster plan migrated to the specified deployment template.

202

(ClusterCrudResponse) 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 Elasticsearch cluster plan (code: 'clusters.cluster_invalid_plan' and 'clusters.plan_feature_not_implemented')

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.needs_elevated_permissions"')

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