A note on terminologyedit

If this is your first time using the ECE API, some of the terminology in the JSON output will likely be unfamiliar. For example, there is a reference to the term “plan” in output fields such as plan_info. A plan is just a cluster configuration that gets applied to a cluster. When you change a cluster to resize it, for example, you are applying a new plan.

In the UI, there are also many references to deployments that Elasticsearch clusters, Kibana instances, and other products of the Elastic Stack running on ECE are grouped into. If you look at the JSON output, you will notice that there is no mention of deployments at all. The reason for this is that the entire plan for a cluster is part of a deployment. For example: When you are running an Elasticsearch cluster that has a Kibana instance associated with it, you are running a deployment.