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.
KibanaPayload
editKibanaPayload
editA Kibana creation request paired with the alias of the Elasticsearch cluster it should be paired with
Properties
edit-
display_name(string) - The human readable name for the Kibana cluster (default: takes the name of its Elasticsearch cluster)
-
elasticsearch_cluster_ref_id(string, required) - Alias to the Elasticsearch Cluster to attach Kibana to
-
plan(KibanaClusterPlan, required) - The plan for the Kibana instance.
-
ref_id(string, required) - A locally-unique user-specified id for Kibana
-
region(string, required) - The region where this resource exists
-
settings(KibanaClusterSettings) - The settings for building this Kibana cluster
Example
edit{
"display_name" : "string",
"elasticsearch_cluster_ref_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"
]
}
],
"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
},
"ref_id" : "string",
"region" : "string",
"settings" : {
"metadata" : {
"contact_email" : "string",
"hidden" : true,
"name" : "string",
"organization_id" : "string",
"owner_id" : "string",
"resources" : {
"cpu" : {
"boost" : true,
"hard_limit" : true
}
},
"subscription_level" : "string",
"system_owned" : true
}
}
}