IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

› › › ›

Create cluster

edit

IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

Create cluster

edit

This endpoint is deprecated and scheduled to be removed in the next major version. Use update deployment instead.

Creates a Kibana instance for the Elasticsearch cluster.

Request

edit

POST /api/v1/clusters/kibana

Query parameters

edit

Name	Type	Required	Description
`validate_only`	`boolean`; default: `false`	N	When `true`, validates the cluster definition without creating the cluster.

Request body

edit

(CreateKibanaRequest) (required) The cluster 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

201

(ClusterCrudResponse)

The cluster definition was valid and the cluster creation has started

400

(BasicFailedReply)

The cluster definition contained errors (code: 'clusters.cluster_invalid_plan' and 'clusters.plan_feature_not_implemented')

449

(BasicFailedReply)

elevated permissions are required. (code: '"root.unauthorized.rbac.elevated_permissions_required"')

Request example

edit

curl -XPOST https://{{hostname}}/api/v1/clusters/kibana \
-H "Authorization: ApiKey $ECE_API_KEY" \
-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" : {
         "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
   }
}
'

« Get clusters Delete cluster »