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.
Update plan
editUpdate plan
editDEPRECATED (Scheduled to be removed in the next major version): Updates the configuration of the Kibana instance.
Request
editPOST /api/v1/clusters/kibana/{cluster_id}/plan
Path parameters
editName | Type | Required | Description |
---|---|---|---|
|
|
Y |
The Kibana deployment identifier. |
Query parameters
editName | Type | Required | Description |
---|---|---|---|
|
|
N |
When |
Request body
edit(KibanaClusterPlan
) (required) The update plan definition
Responses
edit-
200
-
(
ClusterCrudResponse
) The cluster definition was valid - no further action was requested. The return object contains an internal representation of the plan, for use in debugging -
202
-
(
ClusterCrudResponse
) The plan definition was valid and the updated plan is in progress -
400
-
(
BasicFailedReply
) The cluster definition contained errors (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') -
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
editcurl -XPOST https://{{hostname}}/api/v1/clusters/kibana/{cluster_id}/plan \ -H "Authorization: ApiKey $ECE_API_KEY" \ -H 'Content-Type: application/json' \ -d ' { "cluster_topology" : [ { "allocator_filter" : {}, "instance_configuration_id" : "string", "kibana" : { "docker_image" : "string", "system_settings" : { "elasticsearch_password" : "string", "elasticsearch_url" : "string", "elasticsearch_username" : "string" }, "user_settings_json" : {}, "user_settings_override_json" : {}, "user_settings_override_yaml" : "string", "user_settings_yaml" : "string", "version" : "string" }, "memory_per_node" : 0, "node_configuration" : "string", "node_count_per_zone" : 0, "size" : { "resource" : "string", "value" : 0 }, "zone_count" : 0 } ], "kibana" : null, "transient" : { "plan_configuration" : { "calm_wait_time" : 0, "cluster_reboot" : "string", "extended_maintenance" : true, "move_allocators" : [ { "allocator_down" : true, "from" : "string", "to" : [ "string" ] } ], "move_instances" : [ { "from" : "string", "instance_down" : true, "to" : [ "string" ] } ], "preferred_allocators" : [ "string" ], "reallocate_instances" : true, "timeout" : 0 }, "strategy" : { "autodetect" : {}, "grow_and_shrink" : {}, "rolling" : { "allow_inline_resize" : true, "group_by" : "string", "shard_init_wait_time" : 0, "skip_synced_flush" : true }, "rolling_grow_and_shrink" : {} } }, "zone_count" : 0 } '