Skip to main content
GET
/
deployments
/
{deployment_id}
/
elasticsearch
/
{ref_id}
Get Deployment Elasticsearch Resource Info
curl --request GET \
  --url https://api.elastic-cloud.com/api/v1/deployments/{deployment_id}/elasticsearch/{ref_id} \
  --header 'Authorization: <api-key>'
{
  "id": "<string>",
  "info": {
    "associated_apm_clusters": [
      {
        "apm_id": "<string>",
        "enabled": "<boolean>",
        "links": {
          "amet_e7": {
            "need_elevated_permissions": "<boolean>"
          }
        }
      }
    ],
    "associated_appsearch_clusters": [
      {
        "app_search_id": "<string>",
        "enabled": "<boolean>",
        "links": {
          "pariatur8de": {
            "need_elevated_permissions": "<boolean>"
          },
          "sunt08_": {
            "need_elevated_permissions": "<boolean>"
          }
        }
      }
    ],
    "associated_enterprise_search_clusters": [
      {
        "enabled": "<boolean>",
        "enterprise_search_id": "<string>",
        "links": {
          "adipisicing_62f": {
            "need_elevated_permissions": "<boolean>"
          },
          "dolor_2": {
            "need_elevated_permissions": "<boolean>"
          },
          "eu_d1": {
            "need_elevated_permissions": "<boolean>"
          },
          "exercitation_3": {
            "need_elevated_permissions": "<boolean>"
          }
        }
      }
    ],
    "associated_kibana_clusters": [
      {
        "enabled": "<boolean>",
        "kibana_id": "<string>",
        "links": {
          "amet__b9": {
            "need_elevated_permissions": "<boolean>"
          }
        }
      }
    ],
    "cluster_id": "<string>",
    "cluster_name": "<string>",
    "deployment_id": "<string>",
    "elasticsearch": {
      "blocking_issues": {
        "cluster_level": [
          {
            "description": "<string>",
            "instances": [
              "<string>"
            ]
          }
        ],
        "healthy": "<boolean>",
        "index_level": [
          {
            "description": "<string>",
            "instances": [
              "<string>"
            ]
          }
        ]
      },
      "cluster_blocking_issues": {
        "blocks": [
          {
            "description": "<string>",
            "level": "index"
          }
        ],
        "healthy": "<boolean>"
      },
      "healthy": "<boolean>",
      "master_info": {
        "healthy": "<boolean>",
        "instances_with_no_master": [
          "<string>"
        ],
        "masters": [
          {
            "instances": [
              "<string>"
            ],
            "master_instance_name": "<string>",
            "master_node_id": "<string>"
          }
        ]
      },
      "shard_info": {
        "available_shards": [
          {
            "instance_name": "<string>",
            "shard_count": "<integer>"
          }
        ],
        "healthy": "<boolean>",
        "unavailable_replicas": [
          {
            "instance_name": "<string>",
            "replica_count": "<integer>"
          }
        ],
        "unavailable_shards": [
          {
            "instance_name": "<string>",
            "shard_count": "<integer>"
          }
        ]
      },
      "shards_status": {
        "status": "green"
      }
    },
    "elasticsearch_monitoring_info": {
      "destination_cluster_ids": [
        "<string>"
      ],
      "healthy": "<boolean>",
      "last_modified": "<dateTime>",
      "last_update_status": "<string>",
      "source_cluster_ids": [
        "<string>"
      ]
    },
    "external_links": [
      {
        "id": "<string>",
        "label": "<string>",
        "uri": "<string>"
      }
    ],
    "healthy": "<boolean>",
    "links": {
      "minim_a": {
        "need_elevated_permissions": "<boolean>"
      },
      "mollit_f": {
        "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": {
            "sint_a": "<string>"
          },
          "failure_type": "<string>",
          "message": "<string>",
          "timestamp": "<dateTime>"
        },
        "healthy": "<boolean>",
        "plan": {
          "autoscaling_enabled": "<boolean>",
          "cluster_topology": [
            {
              "autoscaling_max": {
                "resource": "storage",
                "value": "<integer>"
              },
              "autoscaling_min": {
                "resource": "memory",
                "value": "<integer>"
              },
              "autoscaling_policy_override_json": {},
              "autoscaling_tier_override": "<boolean>",
              "elasticsearch": {
                "curation": {
                  "from_instance_configuration_id": "<string>",
                  "to_instance_configuration_id": "<string>"
                },
                "docker_image": "<string>",
                "enabled_built_in_plugins": [
                  "<string>"
                ],
                "node_attributes": {
                  "cupidatat_5b": "<string>"
                },
                "system_settings": {
                  "auto_create_index": "<boolean>",
                  "default_shards_per_index": "<integer>",
                  "destructive_requires_name": "<boolean>",
                  "enable_close_index": "<boolean>",
                  "monitoring_collection_interval": "<integer>",
                  "monitoring_history_duration": "<string>",
                  "reindex_whitelist": [
                    "<string>"
                  ],
                  "scripting": {
                    "expressions_enabled": "<boolean>",
                    "file": {
                      "enabled": "<boolean>",
                      "sandbox_mode": "<boolean>"
                    },
                    "inline": {
                      "enabled": "<boolean>",
                      "sandbox_mode": "<boolean>"
                    },
                    "mustache_enabled": "<boolean>",
                    "painless_enabled": "<boolean>",
                    "stored": {
                      "enabled": "<boolean>",
                      "sandbox_mode": "<boolean>"
                    }
                  },
                  "watcher_trigger_engine": "<string>"
                },
                "user_bundles": [
                  {
                    "elasticsearch_version": "<string>",
                    "name": "<string>",
                    "url": "<string>"
                  }
                ],
                "user_plugins": [
                  {
                    "elasticsearch_version": "<string>",
                    "name": "<string>",
                    "url": "<string>"
                  }
                ],
                "user_settings_json": {},
                "user_settings_override_json": {},
                "user_settings_override_yaml": "<string>",
                "user_settings_yaml": "<string>",
                "version": "<string>"
              },
              "id": "<string>",
              "instance_configuration_id": "<string>",
              "instance_configuration_version": "<integer>",
              "node_roles": [
                "data_hot"
              ],
              "node_type": {
                "data": "<boolean>",
                "ingest": "<boolean>",
                "master": "<boolean>",
                "ml": "<boolean>"
              },
              "size": {
                "resource": "memory",
                "value": "<integer>"
              },
              "topology_element_control": {
                "min": {
                  "resource": "storage",
                  "value": "<integer>"
                }
              },
              "zone_count": "<integer>"
            }
          ],
          "deployment_template": {
            "id": "<string>",
            "version": "<string>"
          },
          "elasticsearch": {
            "curation": {
              "from_instance_configuration_id": "<string>",
              "to_instance_configuration_id": "<string>"
            },
            "docker_image": "<string>",
            "enabled_built_in_plugins": [
              "<string>"
            ],
            "node_attributes": {
              "ead7a": "<string>"
            },
            "system_settings": {
              "auto_create_index": "<boolean>",
              "default_shards_per_index": "<integer>",
              "destructive_requires_name": "<boolean>",
              "enable_close_index": "<boolean>",
              "monitoring_collection_interval": "<integer>",
              "monitoring_history_duration": "<string>",
              "reindex_whitelist": [
                "<string>"
              ],
              "scripting": {
                "expressions_enabled": "<boolean>",
                "file": {
                  "enabled": "<boolean>",
                  "sandbox_mode": "<boolean>"
                },
                "inline": {
                  "enabled": "<boolean>",
                  "sandbox_mode": "<boolean>"
                },
                "mustache_enabled": "<boolean>",
                "painless_enabled": "<boolean>",
                "stored": {
                  "enabled": "<boolean>",
                  "sandbox_mode": "<boolean>"
                }
              },
              "watcher_trigger_engine": "<string>"
            },
            "user_bundles": [
              {
                "elasticsearch_version": "<string>",
                "name": "<string>",
                "url": "<string>"
              }
            ],
            "user_plugins": [
              {
                "elasticsearch_version": "<string>",
                "name": "<string>",
                "url": "<string>"
              }
            ],
            "user_settings_json": {},
            "user_settings_override_json": {},
            "user_settings_override_yaml": "<string>",
            "user_settings_yaml": "<string>",
            "version": "<string>"
          },
          "transient": {
            "cluster_settings_json": {},
            "plan_configuration": {
              "calm_wait_time": "<long>",
              "cluster_reboot": "forced",
              "extended_maintenance": "<boolean>",
              "max_snapshot_age": "<long>",
              "max_snapshot_attempts": "<integer>",
              "skip_snapshot": "<boolean>",
              "timeout": "<long>"
            },
            "remote_clusters": {
              "resources": [
                {
                  "alias": "<string>",
                  "deployment_id": "<string>",
                  "elasticsearch_ref_id": "<string>",
                  "info": {
                    "compatible": "<boolean>",
                    "connected": "<boolean>",
                    "healthy": "<boolean>",
                    "trusted": "<boolean>",
                    "trusted_back": "<boolean>"
                  },
                  "skip_unavailable": "<boolean>"
                }
              ]
            },
            "restore_snapshot": {
              "repository_config": {
                "raw_settings": {}
              },
              "repository_name": "<string>",
              "restore_payload": {
                "indices": [
                  "<string>"
                ],
                "raw_settings": {}
              },
              "snapshot_name": "<string>",
              "source_cluster_id": "<string>",
              "strategy": "full"
            },
            "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": {
                  "cillum9": "<string>",
                  "culpa_9c3": "<string>",
                  "ex_3": "<string>",
                  "ut_10": "<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>"
          }
        ]
      },
      "healthy": "<boolean>",
      "history": [
        {
          "attempt_end_time": "<dateTime>",
          "attempt_start_time": "<dateTime>",
          "error": {
            "details": {
              "Loremc68": "<string>"
            },
            "failure_type": "<string>",
            "message": "<string>",
            "timestamp": "<dateTime>"
          },
          "healthy": "<boolean>",
          "plan": {
            "autoscaling_enabled": "<boolean>",
            "cluster_topology": [
              {
                "autoscaling_max": {
                  "resource": "memory",
                  "value": "<integer>"
                },
                "autoscaling_min": {
                  "resource": "memory",
                  "value": "<integer>"
                },
                "autoscaling_policy_override_json": {},
                "autoscaling_tier_override": "<boolean>",
                "elasticsearch": {
                  "curation": {
                    "from_instance_configuration_id": "<string>",
                    "to_instance_configuration_id": "<string>"
                  },
                  "docker_image": "<string>",
                  "enabled_built_in_plugins": [
                    "<string>"
                  ],
                  "node_attributes": {
                    "ex_fc": "<string>",
                    "pariatur327": "<string>"
                  },
                  "system_settings": {
                    "auto_create_index": "<boolean>",
                    "default_shards_per_index": "<integer>",
                    "destructive_requires_name": "<boolean>",
                    "enable_close_index": "<boolean>",
                    "monitoring_collection_interval": "<integer>",
                    "monitoring_history_duration": "<string>",
                    "reindex_whitelist": [
                      "<string>"
                    ],
                    "scripting": {
                      "expressions_enabled": "<boolean>",
                      "file": {
                        "enabled": "<boolean>",
                        "sandbox_mode": "<boolean>"
                      },
                      "inline": {
                        "enabled": "<boolean>",
                        "sandbox_mode": "<boolean>"
                      },
                      "mustache_enabled": "<boolean>",
                      "painless_enabled": "<boolean>",
                      "stored": {
                        "enabled": "<boolean>",
                        "sandbox_mode": "<boolean>"
                      }
                    },
                    "watcher_trigger_engine": "<string>"
                  },
                  "user_bundles": [
                    {
                      "elasticsearch_version": "<string>",
                      "name": "<string>",
                      "url": "<string>"
                    }
                  ],
                  "user_plugins": [
                    {
                      "elasticsearch_version": "<string>",
                      "name": "<string>",
                      "url": "<string>"
                    }
                  ],
                  "user_settings_json": {},
                  "user_settings_override_json": {},
                  "user_settings_override_yaml": "<string>",
                  "user_settings_yaml": "<string>",
                  "version": "<string>"
                },
                "id": "<string>",
                "instance_configuration_id": "<string>",
                "instance_configuration_version": "<integer>",
                "node_roles": [
                  "data_cold"
                ],
                "node_type": {
                  "data": "<boolean>",
                  "ingest": "<boolean>",
                  "master": "<boolean>",
                  "ml": "<boolean>"
                },
                "size": {
                  "resource": "memory",
                  "value": "<integer>"
                },
                "topology_element_control": {
                  "min": {
                    "resource": "storage",
                    "value": "<integer>"
                  }
                },
                "zone_count": "<integer>"
              }
            ],
            "deployment_template": {
              "id": "<string>",
              "version": "<string>"
            },
            "elasticsearch": {
              "curation": {
                "from_instance_configuration_id": "<string>",
                "to_instance_configuration_id": "<string>"
              },
              "docker_image": "<string>",
              "enabled_built_in_plugins": [
                "<string>"
              ],
              "node_attributes": {
                "mollitb": "<string>"
              },
              "system_settings": {
                "auto_create_index": "<boolean>",
                "default_shards_per_index": "<integer>",
                "destructive_requires_name": "<boolean>",
                "enable_close_index": "<boolean>",
                "monitoring_collection_interval": "<integer>",
                "monitoring_history_duration": "<string>",
                "reindex_whitelist": [
                  "<string>"
                ],
                "scripting": {
                  "expressions_enabled": "<boolean>",
                  "file": {
                    "enabled": "<boolean>",
                    "sandbox_mode": "<boolean>"
                  },
                  "inline": {
                    "enabled": "<boolean>",
                    "sandbox_mode": "<boolean>"
                  },
                  "mustache_enabled": "<boolean>",
                  "painless_enabled": "<boolean>",
                  "stored": {
                    "enabled": "<boolean>",
                    "sandbox_mode": "<boolean>"
                  }
                },
                "watcher_trigger_engine": "<string>"
              },
              "user_bundles": [
                {
                  "elasticsearch_version": "<string>",
                  "name": "<string>",
                  "url": "<string>"
                }
              ],
              "user_plugins": [
                {
                  "elasticsearch_version": "<string>",
                  "name": "<string>",
                  "url": "<string>"
                }
              ],
              "user_settings_json": {},
              "user_settings_override_json": {},
              "user_settings_override_yaml": "<string>",
              "user_settings_yaml": "<string>",
              "version": "<string>"
            },
            "transient": {
              "cluster_settings_json": {},
              "plan_configuration": {
                "calm_wait_time": "<long>",
                "cluster_reboot": "forced",
                "extended_maintenance": "<boolean>",
                "max_snapshot_age": "<long>",
                "max_snapshot_attempts": "<integer>",
                "skip_snapshot": "<boolean>",
                "timeout": "<long>"
              },
              "remote_clusters": {
                "resources": [
                  {
                    "alias": "<string>",
                    "deployment_id": "<string>",
                    "elasticsearch_ref_id": "<string>",
                    "info": {
                      "compatible": "<boolean>",
                      "connected": "<boolean>",
                      "healthy": "<boolean>",
                      "trusted": "<boolean>",
                      "trusted_back": "<boolean>"
                    },
                    "skip_unavailable": "<boolean>"
                  }
                ]
              },
              "restore_snapshot": {
                "repository_config": {
                  "raw_settings": {}
                },
                "repository_name": "<string>",
                "restore_payload": {
                  "indices": [
                    "<string>"
                  ],
                  "raw_settings": {}
                },
                "snapshot_name": "<string>",
                "source_cluster_id": "<string>",
                "strategy": "partial"
              },
              "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": {
                    "aliquip__4": "<string>",
                    "dolore21": "<string>",
                    "id76": "<string>"
                  },
                  "failure_type": "<string>",
                  "message": "<string>",
                  "stage": "completed",
                  "timestamp": "<dateTime>"
                }
              ],
              "stage": "starting",
              "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": {
            "adb26": "<string>"
          },
          "failure_type": "<string>",
          "message": "<string>",
          "timestamp": "<dateTime>"
        },
        "healthy": "<boolean>",
        "plan": {
          "autoscaling_enabled": "<boolean>",
          "cluster_topology": [
            {
              "autoscaling_max": {
                "resource": "storage",
                "value": "<integer>"
              },
              "autoscaling_min": {
                "resource": "memory",
                "value": "<integer>"
              },
              "autoscaling_policy_override_json": {},
              "autoscaling_tier_override": "<boolean>",
              "elasticsearch": {
                "curation": {
                  "from_instance_configuration_id": "<string>",
                  "to_instance_configuration_id": "<string>"
                },
                "docker_image": "<string>",
                "enabled_built_in_plugins": [
                  "<string>"
                ],
                "node_attributes": {
                  "consequat_b": "<string>",
                  "elit_1f": "<string>",
                  "enim_965": "<string>",
                  "laboris_54e": "<string>"
                },
                "system_settings": {
                  "auto_create_index": "<boolean>",
                  "default_shards_per_index": "<integer>",
                  "destructive_requires_name": "<boolean>",
                  "enable_close_index": "<boolean>",
                  "monitoring_collection_interval": "<integer>",
                  "monitoring_history_duration": "<string>",
                  "reindex_whitelist": [
                    "<string>"
                  ],
                  "scripting": {
                    "expressions_enabled": "<boolean>",
                    "file": {
                      "enabled": "<boolean>",
                      "sandbox_mode": "<boolean>"
                    },
                    "inline": {
                      "enabled": "<boolean>",
                      "sandbox_mode": "<boolean>"
                    },
                    "mustache_enabled": "<boolean>",
                    "painless_enabled": "<boolean>",
                    "stored": {
                      "enabled": "<boolean>",
                      "sandbox_mode": "<boolean>"
                    }
                  },
                  "watcher_trigger_engine": "<string>"
                },
                "user_bundles": [
                  {
                    "elasticsearch_version": "<string>",
                    "name": "<string>",
                    "url": "<string>"
                  }
                ],
                "user_plugins": [
                  {
                    "elasticsearch_version": "<string>",
                    "name": "<string>",
                    "url": "<string>"
                  }
                ],
                "user_settings_json": {},
                "user_settings_override_json": {},
                "user_settings_override_yaml": "<string>",
                "user_settings_yaml": "<string>",
                "version": "<string>"
              },
              "id": "<string>",
              "instance_configuration_id": "<string>",
              "instance_configuration_version": "<integer>",
              "node_roles": [
                "data_hot"
              ],
              "node_type": {
                "data": "<boolean>",
                "ingest": "<boolean>",
                "master": "<boolean>",
                "ml": "<boolean>"
              },
              "size": {
                "resource": "memory",
                "value": "<integer>"
              },
              "topology_element_control": {
                "min": {
                  "resource": "storage",
                  "value": "<integer>"
                }
              },
              "zone_count": "<integer>"
            }
          ],
          "deployment_template": {
            "id": "<string>",
            "version": "<string>"
          },
          "elasticsearch": {
            "curation": {
              "from_instance_configuration_id": "<string>",
              "to_instance_configuration_id": "<string>"
            },
            "docker_image": "<string>",
            "enabled_built_in_plugins": [
              "<string>"
            ],
            "node_attributes": {
              "Excepteur_0": "<string>",
              "eu5": "<string>"
            },
            "system_settings": {
              "auto_create_index": "<boolean>",
              "default_shards_per_index": "<integer>",
              "destructive_requires_name": "<boolean>",
              "enable_close_index": "<boolean>",
              "monitoring_collection_interval": "<integer>",
              "monitoring_history_duration": "<string>",
              "reindex_whitelist": [
                "<string>"
              ],
              "scripting": {
                "expressions_enabled": "<boolean>",
                "file": {
                  "enabled": "<boolean>",
                  "sandbox_mode": "<boolean>"
                },
                "inline": {
                  "enabled": "<boolean>",
                  "sandbox_mode": "<boolean>"
                },
                "mustache_enabled": "<boolean>",
                "painless_enabled": "<boolean>",
                "stored": {
                  "enabled": "<boolean>",
                  "sandbox_mode": "<boolean>"
                }
              },
              "watcher_trigger_engine": "<string>"
            },
            "user_bundles": [
              {
                "elasticsearch_version": "<string>",
                "name": "<string>",
                "url": "<string>"
              }
            ],
            "user_plugins": [
              {
                "elasticsearch_version": "<string>",
                "name": "<string>",
                "url": "<string>"
              }
            ],
            "user_settings_json": {},
            "user_settings_override_json": {},
            "user_settings_override_yaml": "<string>",
            "user_settings_yaml": "<string>",
            "version": "<string>"
          },
          "transient": {
            "cluster_settings_json": {},
            "plan_configuration": {
              "calm_wait_time": "<long>",
              "cluster_reboot": "forced",
              "extended_maintenance": "<boolean>",
              "max_snapshot_age": "<long>",
              "max_snapshot_attempts": "<integer>",
              "skip_snapshot": "<boolean>",
              "timeout": "<long>"
            },
            "remote_clusters": {
              "resources": [
                {
                  "alias": "<string>",
                  "deployment_id": "<string>",
                  "elasticsearch_ref_id": "<string>",
                  "info": {
                    "compatible": "<boolean>",
                    "connected": "<boolean>",
                    "healthy": "<boolean>",
                    "trusted": "<boolean>",
                    "trusted_back": "<boolean>"
                  },
                  "skip_unavailable": "<boolean>"
                }
              ]
            },
            "restore_snapshot": {
              "repository_config": {
                "raw_settings": {}
              },
              "repository_name": "<string>",
              "restore_payload": {
                "indices": [
                  "<string>"
                ],
                "raw_settings": {}
              },
              "snapshot_name": "<string>",
              "source_cluster_id": "<string>",
              "strategy": "recovery"
            },
            "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": {
                  "est_e": "<string>",
                  "laboris_2": "<string>",
                  "pariatur_c29": "<string>",
                  "suntd": "<string>"
                },
                "failure_type": "<string>",
                "message": "<string>",
                "stage": "starting",
                "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>",
    "security": {
      "last_modified": "<dateTime>",
      "roles": {},
      "users": [
        {
          "password_hash": "<string>",
          "username": "<string>"
        }
      ],
      "users_roles": [
        {
          "roles": [
            "<string>"
          ],
          "username": "<string>"
        }
      ],
      "version": "<integer>"
    },
    "settings": {
      "curation": {
        "specs": [
          {
            "index_pattern": "<string>",
            "trigger_interval_seconds": "<integer>"
          }
        ]
      },
      "dedicated_masters_threshold": "<integer>",
      "keystore_contents": {
        "secrets": {
          "culpa_3": {
            "as_file": "<boolean>",
            "value": {}
          },
          "fugiat_3": {
            "as_file": "<boolean>",
            "value": {}
          },
          "id75": {
            "as_file": "<boolean>",
            "value": {}
          }
        }
      },
      "metadata": {
        "name": "<string>"
      },
      "monitoring": {
        "target_cluster_id": "<string>"
      },
      "snapshot": {
        "cron_expression": "<string>",
        "interval": "<string>",
        "retention": {
          "max_age": "<string>",
          "snapshots": "<integer>"
        },
        "slm": "<boolean>"
      },
      "traffic_filter": {
        "rulesets": [
          "<string>"
        ]
      },
      "trust": {
        "accounts": [
          {
            "account_id": "<string>",
            "name": "<string>",
            "trust_all": "<boolean>",
            "trust_allowlist": [
              "<string>"
            ]
          }
        ],
        "direct": [
          {
            "additional_node_names": [
              "<string>"
            ],
            "certificates": [
              {
                "metadata": {
                  "also_trusted_by": [
                    "<string>"
                  ],
                  "fingerprint": "<string>",
                  "valid_from": "<dateTime>",
                  "valid_to": "<dateTime>"
                },
                "pem": "<string>"
              }
            ],
            "name": "<string>",
            "scope_id": "<string>",
            "trust_all": "<boolean>",
            "trust_allowlist": [
              "<string>"
            ],
            "type": "ECE",
            "uid": "<string>"
          }
        ],
        "external": [
          {
            "name": "<string>",
            "trust_all": "<boolean>",
            "trust_allowlist": [
              "<string>"
            ],
            "trust_relationship_id": "<string>"
          }
        ]
      }
    },
    "snapshots": {
      "count": "<integer>",
      "healthy": "<boolean>",
      "latest_end_time": "<dateTime>",
      "latest_status": "<string>",
      "latest_successful": "<boolean>",
      "latest_successful_end_time": "<dateTime>",
      "recent_success": "<boolean>",
      "scheduled_time": "<dateTime>"
    },
    "status": "reconfiguring",
    "system_alerts": [
      {
        "alert_type": "automatic_restart",
        "exit_code": "<integer>",
        "instance_name": "<string>",
        "timestamp": "<dateTime>",
        "url": "<string>"
      }
    ],
    "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": "storage"
          },
          "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_content"
          ],
          "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_security
string

Whether to include the Elasticsearch 2.x security information in the response - can be large per cluster and also include credentials.

Example:

"false"

​
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_system_alerts
string

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.

Example:

"0"

​
show_settings
string

Whether to show cluster settings in the response.

Example:

"false"

​
enrich_with_template
string

If showing plans, whether to enrich the plan by including the missing elements from the deployment template it is based on.

Example:

"true"

​
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.

​
id
string
Example:

"<string>"

​
info
object
​
ref_id
string
Example:

"<string>"

​
region
string
Example:

"<string>"

⌘I