A newer version is available. For the latest information, see the current release documentation.
Elastic Docs ›Elastic Cloud Enterprise Reference [2.2] ›RESTful API ›API reference ›Clusters - Kibana - CRUD - Configuration
« Update cluster metadata settings Update plan »

Get planedit

Retrieves the active plan of the Kibana instance. Transient settings are not show by this endpoint. To view the transient settings that have been applied with a specific plan, use the activity endpoint.

Requestedit

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

Path parametersedit

Name Type Required Description

cluster_id

string

Y

The Kibana deployment identifier.

Query parametersedit

Name Type Required Description

convert_legacy_plans

boolean; default: false

N

When true, converts the plans to the 2.0.x format. When false, uses the 1.x format. The default is false.

show_plan_defaults

boolean; default: false

N

When plans are shown, includes the default values in the response. NOTE: This option results in large responses.

Responsesedit

200

(KibanaClusterPlan) The pending plan is applied to the Kibana deployment.

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 resource version, which is used to avoid update conflicts with concurrent operations
404

(BasicFailedReply) The {cluster_id} can't be found. (code: 'clusters.cluster_not_found')

412

(BasicFailedReply) The Kibana deployment is unable to finish provisioning, or the provisioning failed. Apply a plan, then try again. (code: 'clusters.cluster_plan_state_error')

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

Request exampleedit

curl -XGET {{hostname}}/api/v1/clusters/kibana/{cluster_id}/plan \
-u $CLOUD_USER:$CLOUD_KEY
« Update cluster metadata settings Update plan »