Get plan

Retrieves the active plan of an Elasticsearch cluster.

Request

GET /api/v1/clusters/elasticsearch/{cluster_id}/plan

Path Parameters

cluster_id (required)
(string) Identifier for the Elasticsearch cluster

Query Parameters

convert_legacy_plans
(boolean; default: false) Whether to leave pre-2.0.0 plans in their legacy format (the default), or whether to update them to 2.0.x+ format (if 'true')
enrich_with_template
(boolean; default: true) If showing plans, whether to enrich the plan by including the missing elements from the deployment template it is based on
show_plan_defaults
(boolean; default: false) Whether to show values that are left at their default value (less readable but more informative)

Responses

200

(ElasticsearchClusterPlan) The cluster has a current applied plan

Headers

x-cloud-resource-created (string)
The date-time when the resource was created (ISO format relative to UTC)
x-cloud-resource-last-modified (string)
The date-time when the resource was last modified (ISO format relative to UTC)
x-cloud-resource-version (string)
The version of the resource - used to avoid update conflicts from multiple concurrent operations
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')