Elasticsearch API Documentation
Get Deployment Elasticsearch Resource Info
GET {{baseUrl}}/deployments/:deployment_id/elasticsearch/:ref_id?show_security=false&show_metadata=false&show_plans=true&show_plan_logs=false&show_plan_history=false&show_plan_defaults=false&convert_legacy_plans=false&show_system_alerts=0&show_settings=false&enrich_with_template=true
Get info about an Elasticsearch Resource belonging to a given Deployment.
Body
PARAM
| Key | Datatype | Required | Description |
show_security
|
boolean | Whether to include the Elasticsearch 2.x security information in the response - can be large per cluster and also include credentials. | |
show_metadata
|
boolean | Whether to include the full cluster metadata in the response - can be large per cluster and also include credentials. | |
show_plans
|
boolean | Whether to include the full current and pending plan information in the response - can be large per cluster. | |
show_plan_logs
|
boolean | Whether to include with the current and pending plan information the attempt log - can be very large per cluster. | |
show_plan_history
|
boolean | Whether to include with the current and pending plan information the plan history- can be very large per cluster. | |
show_plan_defaults
|
boolean | If showing plans, whether to show values that are left at their default value (less readable but more informative). | |
convert_legacy_plans
|
boolean | 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'). | |
show_system_alerts
|
number | Number of system alerts (such as forced restarts due to memory limits) to be included in the response - can be large per cluster. Negative numbers or 0 will not return field. | |
show_settings
|
boolean | Whether to show cluster settings in the response. | |
enrich_with_template
|
boolean | If showing plans, whether to enrich the plan by including the missing elements from the deployment template it is based on. |
HEADERS
| Key | Datatype | Required | Description |
RESPONSES
status OK
Curl
curl -X GET 'https://api.elastic-cloud.com/api/v1//deployments/:deployment_id/elasticsearch/:ref_id?show_security=false&show_metadata=false&show_plans=true&show_plan_logs=false&show_plan_history=false&show_plan_defaults=false&convert_legacy_plans=false&show_system_alerts=0&show_settings=false&enrich_with_template=true?show_security=false&show_metadata=false&show_plans=true&show_plan_logs=false&show_plan_history=false&show_plan_defaults=false&convert_legacy_plans=false&show_system_alerts=0&show_settings=false&enrich_with_template=true'
ENDPOINTS