Clusters - Kibana - CRUD

Get clusters

Retrieves the information for all Kibana instances.

Request

GET /api/v1/clusters/kibana

Query parameters

Name Type Required Description

from

integer; default: 0

N

The number of clusters to skip.

q

string

N

An optional query to filter Kibana clusters by. Maps to an Elasticsearch query_string query.

show_hidden

boolean; default: false

N

Includes the hidden clusters in the response.

show_metadata

boolean; default: false

N

Includes all of the cluster metadata in the response. NOTE: Responses can include a large amount of metadata, as well as credentials.

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.

show_plans

boolean

N

Includes the active and pending plan information in the response. NOTE: This option can result in large responses.

show_settings

boolean; default: false

N

Includes the cluster settings in the response.

size

integer; default: 100

N

The maximum number of clusters to include in the response. For all clusters, use -1. NOTE: This option can result in large responses.

Responses

200
(KibanaClustersInfo) Returning the specified set of clusters from the platform
Warning

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

Request example

curl -XGET {{hostname}}/api/v1/clusters/kibana \
-u $CLOUD_USER:$CLOUD_KEY

Create cluster

Creates a Kibana instance for the Elasticsearch cluster.

Request

POST /api/v1/clusters/kibana

Query parameters

Name Type Required Description

validate_only

boolean; default: false

N

When true, validates the cluster definition without creating the cluster.

Request body

(CreateKibanaRequest) (required) The cluster definition

Responses

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"')
Warning

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

Request example

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
   }
}
'

Delete cluster

Deletes the Kibana instance. Before you delete the Kibana instance, you must first successfully issue a _shutdown command.

Request

DELETE /api/v1/clusters/kibana/{cluster_id}

Path parameters

Name Type Required Description

cluster_id

string

Y

The Kibana deployment identifier.

Responses

200
(EmptyResponse) The cluster has been successfully deleted
404
(BasicFailedReply) The cluster specified by {cluster_id} cannot be found (code: 'clusters.cluster_not_found')
412
(BasicFailedReply) The Kibana cluster has not been shutdown yet (code: 'clusters.cluster_plan_state_error')
449
(BasicFailedReply) elevated permissions are required. (code: '"root.unauthorized.rbac.elevated_permissions_required"')
Warning

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

Request example

curl -XDELETE {{hostname}}/api/v1/clusters/kibana/{cluster_id} \
-u $CLOUD_USER:$CLOUD_KEY

Get cluster

Retrieves the Kibana instance information.

Request

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

Path parameters

Name Type Required Description

cluster_id

string

Y

The Kibana deployment identifier.

Query parameters

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_metadata

boolean; default: false

N

Includes all of the cluster metadata in the response. NOTE: Responses can include a large amount of metadata, as well as credentials.

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.

show_plan_logs

boolean; default: false

N

Includes the active, pending, and historical plan information in the attempt log. NOTE: This option can result in large responses.

show_plans

boolean; default: true

N

Includes the active and pending plan information in the response. NOTE: This option can result in large responses.

show_settings

boolean; default: false

N

Includes the cluster settings in the response.

Responses

200
(KibanaClusterInfo) Returning the information for the specified Kibana cluster
404
(BasicFailedReply) The cluster specified by {cluster_id} cannot be found (code: 'clusters.cluster_not_found')
Warning

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

Request example

curl -XGET {{hostname}}/api/v1/clusters/kibana/{cluster_id} \
-u $CLOUD_USER:$CLOUD_KEY