Skip to main content
GET
/
deployments
/
{deployment_id}
/
kibana
/
{ref_id}
Get Deployment Kibana Resource Info
curl --request GET \
  --url https://api.elastic-cloud.com/api/v1/deployments/{deployment_id}/kibana/{ref_id} \
  --header 'Authorization: <api-key>'
{
  "elasticsearch_cluster_ref_id": "<string>",
  "id": "<string>",
  "info": {
    "cluster_id": "<string>",
    "cluster_name": "<string>",
    "deployment_id": "<string>",
    "elasticsearch_cluster": {
      "elasticsearch_id": "<string>",
      "links": {
        "Excepteur_9e": {
          "need_elevated_permissions": "<boolean>"
        },
        "aliquip_c": {
          "need_elevated_permissions": "<boolean>"
        },
        "ea48": {
          "need_elevated_permissions": "<boolean>"
        }
      }
    },
    "external_links": [
      {
        "id": "<string>",
        "label": "<string>",
        "uri": "<string>"
      }
    ],
    "healthy": "<boolean>",
    "links": {
      "aute_f6c": {
        "need_elevated_permissions": "<boolean>"
      },
      "dolorea79": {
        "need_elevated_permissions": "<boolean>"
      },
      "ipsuma": {
        "need_elevated_permissions": "<boolean>"
      },
      "mollit_4b": {
        "need_elevated_permissions": "<boolean>"
      },
      "sit_5a": {
        "need_elevated_permissions": "<boolean>"
      }
    },
    "metadata": {
      "aliased_endpoint": "<string>",
      "aliased_url": "<string>",
      "cloud_id": "<string>",
      "endpoint": "<string>",
      "last_modified": "<dateTime>",
      "ports": {
        "http": "<integer>",
        "https": "<integer>",
        "transport_passthrough": "<integer>"
      },
      "raw": {},
      "service_url": "<string>",
      "services_urls": [
        {
          "service": "<string>",
          "url": "<string>"
        }
      ],
      "version": "<integer>"
    },
    "plan_info": {
      "current": {
        "attempt_end_time": "<dateTime>",
        "attempt_start_time": "<dateTime>",
        "error": {
          "details": {
            "Excepteur09_": "<string>",
            "eud": "<string>",
            "fugiat2b": "<string>"
          },
          "failure_type": "<string>",
          "message": "<string>",
          "timestamp": "<dateTime>"
        },
        "healthy": "<boolean>",
        "plan": {
          "cluster_topology": [
            {
              "instance_configuration_id": "<string>",
              "instance_configuration_version": "<integer>",
              "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>"
              },
              "size": {
                "resource": "storage",
                "value": "<integer>"
              },
              "zone_count": "<integer>"
            }
          ],
          "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": "<long>",
              "cluster_reboot": "forced",
              "extended_maintenance": "<boolean>",
              "timeout": "<long>"
            },
            "strategy": {
              "autodetect": {},
              "grow_and_shrink": {},
              "rolling": {
                "allow_inline_resize": "<boolean>",
                "group_by": "<string>",
                "shard_init_wait_time": "<long>",
                "skip_synced_flush": "<boolean>"
              },
              "rolling_grow_and_shrink": {}
            }
          }
        },
        "plan_attempt_id": "<string>",
        "plan_attempt_log": [
          {
            "completed": "<dateTime>",
            "duration_in_millis": "<long>",
            "info_log": [
              {
                "delta_in_millis": "<long>",
                "details": {
                  "anim_2": "<string>",
                  "in_7a5": "<string>",
                  "pariatur_c34": "<string>",
                  "ut_87b": "<string>"
                },
                "failure_type": "<string>",
                "message": "<string>",
                "stage": "starting",
                "timestamp": "<dateTime>"
              }
            ],
            "stage": "in_progress",
            "started": "<dateTime>",
            "status": "warning",
            "step_id": "<string>"
          }
        ],
        "plan_attempt_name": "<string>",
        "plan_end_time": "<dateTime>",
        "source": {
          "action": "<string>",
          "admin_id": "<string>",
          "date": "<dateTime>",
          "facilitator": "<string>",
          "remote_addresses": [
            "<string>"
          ],
          "user_id": "<string>"
        },
        "warnings": [
          {
            "code": "<string>",
            "message": "<string>",
            "step_id": "<string>"
          }
        ]
      },
      "healthy": "<boolean>",
      "history": [
        {
          "attempt_end_time": "<dateTime>",
          "attempt_start_time": "<dateTime>",
          "error": {
            "details": {
              "amet_0b_": "<string>",
              "ullamco_ff": "<string>"
            },
            "failure_type": "<string>",
            "message": "<string>",
            "timestamp": "<dateTime>"
          },
          "healthy": "<boolean>",
          "plan": {
            "cluster_topology": [
              {
                "instance_configuration_id": "<string>",
                "instance_configuration_version": "<integer>",
                "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>"
                },
                "size": {
                  "resource": "memory",
                  "value": "<integer>"
                },
                "zone_count": "<integer>"
              }
            ],
            "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": "<long>",
                "cluster_reboot": "forced",
                "extended_maintenance": "<boolean>",
                "timeout": "<long>"
              },
              "strategy": {
                "autodetect": {},
                "grow_and_shrink": {},
                "rolling": {
                  "allow_inline_resize": "<boolean>",
                  "group_by": "<string>",
                  "shard_init_wait_time": "<long>",
                  "skip_synced_flush": "<boolean>"
                },
                "rolling_grow_and_shrink": {}
              }
            }
          },
          "plan_attempt_id": "<string>",
          "plan_attempt_log": [
            {
              "completed": "<dateTime>",
              "duration_in_millis": "<long>",
              "info_log": [
                {
                  "delta_in_millis": "<long>",
                  "details": {
                    "ut959": "<string>"
                  },
                  "failure_type": "<string>",
                  "message": "<string>",
                  "stage": "completed",
                  "timestamp": "<dateTime>"
                }
              ],
              "stage": "completed",
              "started": "<dateTime>",
              "status": "pending",
              "step_id": "<string>"
            }
          ],
          "plan_attempt_name": "<string>",
          "plan_end_time": "<dateTime>",
          "source": {
            "action": "<string>",
            "admin_id": "<string>",
            "date": "<dateTime>",
            "facilitator": "<string>",
            "remote_addresses": [
              "<string>"
            ],
            "user_id": "<string>"
          },
          "warnings": [
            {
              "code": "<string>",
              "message": "<string>",
              "step_id": "<string>"
            }
          ]
        }
      ],
      "pending": {
        "attempt_end_time": "<dateTime>",
        "attempt_start_time": "<dateTime>",
        "error": {
          "details": {
            "mollit_6": "<string>"
          },
          "failure_type": "<string>",
          "message": "<string>",
          "timestamp": "<dateTime>"
        },
        "healthy": "<boolean>",
        "plan": {
          "cluster_topology": [
            {
              "instance_configuration_id": "<string>",
              "instance_configuration_version": "<integer>",
              "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>"
              },
              "size": {
                "resource": "memory",
                "value": "<integer>"
              },
              "zone_count": "<integer>"
            }
          ],
          "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": "<long>",
              "cluster_reboot": "forced",
              "extended_maintenance": "<boolean>",
              "timeout": "<long>"
            },
            "strategy": {
              "autodetect": {},
              "grow_and_shrink": {},
              "rolling": {
                "allow_inline_resize": "<boolean>",
                "group_by": "<string>",
                "shard_init_wait_time": "<long>",
                "skip_synced_flush": "<boolean>"
              },
              "rolling_grow_and_shrink": {}
            }
          }
        },
        "plan_attempt_id": "<string>",
        "plan_attempt_log": [
          {
            "completed": "<dateTime>",
            "duration_in_millis": "<long>",
            "info_log": [
              {
                "delta_in_millis": "<long>",
                "details": {
                  "laboree": "<string>",
                  "non_b1c": "<string>"
                },
                "failure_type": "<string>",
                "message": "<string>",
                "stage": "completed",
                "timestamp": "<dateTime>"
              }
            ],
            "stage": "completed",
            "started": "<dateTime>",
            "status": "pending",
            "step_id": "<string>"
          }
        ],
        "plan_attempt_name": "<string>",
        "plan_end_time": "<dateTime>",
        "source": {
          "action": "<string>",
          "admin_id": "<string>",
          "date": "<dateTime>",
          "facilitator": "<string>",
          "remote_addresses": [
            "<string>"
          ],
          "user_id": "<string>"
        },
        "warnings": [
          {
            "code": "<string>",
            "message": "<string>",
            "step_id": "<string>"
          }
        ]
      }
    },
    "region": "<string>",
    "settings": {
      "metadata": {
        "name": "<string>"
      }
    },
    "status": "rebooting",
    "topology": {
      "healthy": "<boolean>",
      "instances": [
        {
          "allocator_id": "<string>",
          "container_started": "<boolean>",
          "disk": {
            "disk_space_available": "<long>",
            "disk_space_used": "<long>",
            "storage_multiplier": "<double>"
          },
          "healthy": "<boolean>",
          "instance_configuration": {
            "config_version": "<integer>",
            "id": "<string>",
            "name": "<string>",
            "resource": "memory"
          },
          "instance_name": "<string>",
          "instance_overrides": {
            "capacity": "<integer>",
            "storage_multiplier": "<double>"
          },
          "maintenance_mode": "<boolean>",
          "memory": {
            "instance_capacity": "<integer>",
            "instance_capacity_planned": "<integer>",
            "memory_pressure": "<integer>",
            "native_memory_pressure": "<integer>"
          },
          "node_roles": [
            "data_frozen"
          ],
          "service_roles": [
            "<string>"
          ],
          "service_running": "<boolean>",
          "service_version": "<string>",
          "zone": "<string>"
        }
      ]
    }
  },
  "ref_id": "<string>",
  "region": "<string>"
}

Authorizations

​
Authorization
string
header
required

Path Parameters

​
deployment_id
string
required

(Required) Identifier for the Deployment

Example:

"<string>"

​
ref_id
string
required

(Required) User-specified RefId for the Resource (or '_main' if there is only one).

Example:

"<string>"

Query Parameters

​
show_metadata
string

Whether to include the full cluster metadata in the response - can be large per cluster and also include credentials.

Example:

"false"

​
show_plans
string

Whether to include the full current and pending plan information in the response - can be large per cluster.

Example:

"true"

​
show_plan_logs
string

Whether to include with the current and pending plan information the attempt log - can be very large per cluster.

Example:

"false"

​
show_plan_history
string

Whether to include with the current and pending plan information the plan history- can be very large per cluster.

Example:

"false"

​
show_plan_defaults
string

If showing plans, whether to show values that are left at their default value (less readable but more informative).

Example:

"false"

​
convert_legacy_plans
string

If showing plans, whether to leave pre-2.0.0 plans in their legacy format (the default), or whether to update them to 2.0.x+ format (if 'true').

Example:

"false"

​
show_settings
string

Whether to show cluster settings in the response.

Example:

"false"

​
clear_transient
string

If set (defaults to false) then removes the transient section from all child resources, making it safe to reapply via an update

Example:

"false"

Response

Standard response.

​
elasticsearch_cluster_ref_id
string
Example:

"<string>"

​
id
string
Example:

"<string>"

​
info
object
​
ref_id
string
Example:

"<string>"

​
region
string
Example:

"<string>"

⌘I