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.
Create clusteredit
Creates a Kibana instance for the Elasticsearch cluster.
Requestedit
POST /api/v1/clusters/kibana
Query parametersedit
Name | Type | Required | Description |
---|---|---|---|
|
|
N |
When |
Request bodyedit
(CreateKibanaRequest
) (required) The cluster definition
Responsesedit
-
200
-
(
ClusterCrudResponse
) The Kibana deployment plan is valid. The return object contains an internal representation of the plan that you can use for debugging. -
201
-
(
ClusterCrudResponse
) The Kibana deployment plan is valid and the creation process has started. -
400
-
(
BasicFailedReply
) The Kibana deployment plan contains errors. (code: 'clusters.cluster_invalid_plan' and 'clusters.plan_feature_not_implemented') -
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 exampleedit
curl -XPOST {{hostname}}/api/v1/clusters/kibana \ -u $CLOUD_USER:$CLOUD_KEY \ -H 'Content-Type: application/json' \ -d ' { "cluster_name" : "string", "elasticsearch_cluster_id" : "string", "plan" : { "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" : { "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 } } '