Update planedit
This endpoint is deprecated and scheduled to be removed in the next major version. Use update deployment instead.
Updates the configuration of the Kibana instance.
Requestedit
POST /api/v1/clusters/kibana/{cluster_id}/plan
Path parametersedit
| Name | Type | Required | Description |
|---|---|---|---|
|
|
Y |
The Kibana deployment identifier. |
Query parametersedit
| Name | Type | Required | Description |
|---|---|---|---|
|
|
N |
When |
Request bodyedit
(KibanaClusterPlan) (required) The update plan definition
Responsesedit
-
200 -
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 -
The plan definition was valid and the updated plan is in progress
-
400 -
The cluster definition contained errors (code: 'clusters.cluster_invalid_plan' and 'clusters.plan_feature_not_implemented')
-
404 -
The cluster specified by {cluster_id} cannot be found (code: 'clusters.cluster_not_found')
-
449 -
elevated permissions are required. (code: '"root.unauthorized.rbac.elevated_permissions_required"')
Request exampleedit
curl -XPOST https://{{hostname}}/api/v1/clusters/kibana/{cluster_id}/plan \
-H "Authorization: ApiKey $ECE_API_KEY" \
-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" : {
"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"
},
"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"
]
}
],
"override_failsafe" : true,
"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
}
'