A note on terminology

edit

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 resource configuration that gets applied to a resource, such as an Elasticsearch cluster or a Kibana instance. When you change an Elasticsearch cluster to resize it, for example, you are applying a new plan.

A deployment is a group of different resources such as Elasticsearch clusters, Kibana instances and other products of the Elastic Stack. In the previous example, the admin-console-elasticsearch deployment only had an Elasticsearch resource, and the logging-and-metrics deployment had both Elasticsearch and Kibana resources.