Type to search.

Tools and APIs for Elastic Cloud on Kubernetes

ECK

Elastic Cloud on Kubernetes extends Kubernetes orchestration capabilities to allow you to deploy and manage components of the Elastic Stack.

Availability

  • Generally available

    This functionality is generally available and ready for production usage.

This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.

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 Elastic 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.
  • The Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats. Availability Preview This functionality is in technical preview and is ready for evaluation. Use with caution in production; it is not recommended for mission-critical workloads. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. Specific Support terms apply. Unless stated otherwise on the page, this functionality is available when your Elastic Stack is deployed on Elastic Cloud Hosted, Elastic Cloud Enterprise, Elastic Cloud on Kubernetes, and self-managed environments. This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes. Elastic CLI: Interact with the Elasticsearch and Kibana APIs of clusters managed by Elastic Cloud on Kubernetes.