Type to search.

Tools and APIs for self-managed clusters

Self-managed

Self-managed deployments are Elastic Stack deployments managed without the assistance of an orchestrator.

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 self-managed clusters.

The following APIs allow you to interact with your Elasticsearch cluster and its data.

  • 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.
Tip

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

Refer to Elasticsearch API keys to learn how to generate API keys for your cluster.

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

  • Elasticsearch clients: Interact with Elasticsearch programmatically to integrate Elasticsearch into your app or website.
  • 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 Elasticsearch and Kibana APIs from a single command-line interface.
  • Elasticsearch command line tools: Utilities for configuring security and performing other tasks from the command line.
  • Kibana command line tools: Utilities for performing security and connectivity related tasks for Kibana from the command line.
  • Elasticsearch Support Diagnostic tool: Captures a point-in-time snapshot of cluster statistics and most Elasticsearch settings for troubleshooting purposes.