Loading

Tools and APIs for Elastic Cloud on Kubernetes

ECK

Review key resources that can be used to interact with and manage your Elastic Cloud on Kubernetes operator and deployments.

You can use the following APIs in an Elastic Cloud on Kubernetes environment.

Tip

Refer to API keys to learn how to generate API keys for your environment.

You can use the Elastic Cloud on Kubernetes API to create and manage Elastic Stack components using Elastic-provided Custom Resource Definitions (CRDs).

The following APIs allow you to interact with your Elasticsearch cluster, its data, and the features available to you in your Elastic Cloud on Kubernetes deployments.

Tip

Refer to Elasticsearch API conventions to learn about headers and request body conventions, and to view examples.

  • Elasticsearch APIs: This set of APIs allows you to interact directly with the Elasticsearch nodes in your deployment. You can ingest data, run search queries, check the health of your clusters, manage snapshots, and more.
  • Kibana APIs: Many Kibana features can be accessed through these APIs, including Kibana objects, patterns, and dashboards, as well as user roles and user sessions. You can use these APIs to configure alerts and actions, and to access health details for the Kibana Task Manager.

Some other Elastic products have APIs to support machine-to-machine operations:

  • ECK diagnostics tool: Use the eck-diagnostics command line tool to create a diagnostic archive to help troubleshoot issues with ECK.