Skip to content

Latest commit

 

History

History
177 lines (119 loc) · 5.03 KB

xpack.rst

File metadata and controls

177 lines (119 loc) · 5.03 KB

X-Pack APIs

X-Pack is an Elastic Stack extension that bundles security, alerting, monitoring, reporting, and graph capabilities into one easy-to-install package. While the X-Pack components are designed to work together seamlessly, you can easily enable or disable the features you want to use.

.. py:module:: elasticsearch.client

X-Pack Info

X-Pack Info API provides general info about the installed X-Pack.

.. autoclass:: XPackClient
   :members:

Cross-Cluster Replication

Cross-Cluster Replication APIs are used to perform cross-cluster replication operations.

.. autoclass:: CcrClient
   :members:

Enrich

Enrich APIs can be used to add data from your existing indices to incoming documents during ingest.

.. autoclass:: EnrichClient
   :members:

EQL

EQL APIs accept EQL to query event-based time series data, such as logs, metrics, and traces.

.. autoclass:: EqlClient
   :members:

Graph Explore

Graph Explore API enables you to extract and summarize information about the documents and terms in your Elasticsearch index.

.. autoclass:: GraphClient
   :members:

Index Lifecycle Management (ILM)

Index Lifecycle Management APIs used to set up policies to automatically manage the index lifecycle.

.. autoclass:: IlmClient
   :members:

Licensing

License APIs can be used to manage your licences.

.. autoclass:: LicenseClient
   :members:

Machine Learning

Machine Learning APIs can be useful for discovering new patterns about your data. For a more detailed explanation about X-Pack's machine learning please refer to the official documentation.

.. autoclass:: MlClient
   :members:

Migration

Migration API helps simplify upgrading X-Pack indices from one version to another.

.. autoclass:: MigrationClient
   :members:

Monitoring

Monitoring API used to collect data from the Elasticsearch nodes, Logstash nodes, Kibana instances, and Beats in your cluster.

.. autoclass:: MonitoringClient
   :members:

Rollup

Rollup API enables searching through rolled-up data using the standard query DSL.

.. autoclass:: RollupClient
   :members:

Searchable Snapshots

Searchable Snapshots API used to perform searchable snapshots operations.

.. autoclass:: SearchableSnapshotsClient
   :members:

Security

Security API can be used to help secure your Elasticsearch cluster. Integrating with LDAP and Active Directory.

.. autoclass:: SecurityClient
   :members:

Snapshot Lifecycle Management (SLM)

Snapshot Lifecycle Management API can be used to set up policies to automatically take snapshots and control how long they are retained.

.. autoclass:: SlmClient
   :members:

SQL

The SQL REST API accepts SQL in a JSON document, executes it, and returns the results.

.. autoclass:: SqlClient
   :members:

SSL Certificate

SSL Certificate API enables you to retrieve information about the X.509 certificates that are used to encrypt communications in your Elasticsearch cluster.

.. autoclass:: SslClient
   :members:

Transform

Transform API manages transformation operations from grabbing data from source indices, transforms it, and saves it to a destination index.

.. autoclass:: TransformClient
   :members:

Watcher

Watcher APIs can be used to notify you when certain pre-defined thresholds have happened.

.. autoclass:: WatcherClient
   :members: