opensearch-pyd/docs/xpack.rst

.. _xpack:

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.


Info
----

`X-Pack info <https://www.elastic.co/guide/en/elasticsearch/reference/7.x/info-api.html>`_
provides general info about the installed X-Pack.

.. py:module:: elasticsearch.client.xpack

.. autoclass:: XPackClient
   :members:


Async Search APIs
-----------------

`Async Search API <https://www.elastic.co/guide/en/elasticsearch/reference/7.x/async-search.html>`_
lets you asynchronously execute a search request, monitor its progress,
and retrieve partial results as they become available.

.. py:module:: elasticsearch.client.async_search

.. autoclass:: AsyncSearchClient
   :members:


Autoscaling APIs
-----------------

`Autoscaling API <https://www.elastic.co/guide/en/elasticsearch/reference/7.x/autoscaling-apis.html>`_
gets the current autoscaling decision based on the configured autoscaling policy.

.. py:module:: elasticsearch.client.autoscaling

.. autoclass:: AutoscalingClient
   :members:


EQL APIs
--------

`EQL API <https://www.elastic.co/guide/en/elasticsearch/reference/7.x/eql.html>`_
allows querying with Event Query Language (EQL) to search logs and events and match
them with shared properties.

.. py:module:: elasticsearch.client.eql

.. autoclass:: EqlClient
   :members:


Graph Explore APIs
------------------

`Graph Explore API <https://www.elastic.co/guide/en/elasticsearch/reference/7.x/graph-explore-api.html>`_
enables you to extract and summarize information about the documents and terms in your Elasticsearch index.

.. py:module:: elasticsearch.client.graph


.. autoclass:: GraphClient
   :members:

Licensing APIs
--------------

`Licensing API <https://www.elastic.co/guide/en/elasticsearch/reference/7.x/licensing-apis.html>`_
can be used to manage your licences.


.. py:module:: elasticsearch.client.license


.. autoclass:: LicenseClient
   :members:

Machine Learning APIs
---------------------

`Machine Learning <https://www.elastic.co/guide/en/elasticsearch/reference/7.x/ml-apis.html>`_
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.


.. py:module:: elasticsearch.client.ml


.. autoclass:: MlClient
   :members:

Security APIs
-------------

`Security API <https://www.elastic.co/guide/en/elasticsearch/reference/7.x/security-api.html>`_
can be used to help secure your Elasticsearch cluster. Integrating with LDAP and Active Directory.

.. py:module:: elasticsearch.client.security


.. autoclass:: SecurityClient
   :members:

Watcher APIs
-------------

`Watcher API <https://www.elastic.co/guide/en/elasticsearch/reference/7.x/watcher-api.html>`_
can be used to notify you when certain pre-defined thresholds have happened.

.. py:module:: elasticsearch.client.watcher

.. autoclass:: WatcherClient
   :members:


Migration APIs
---------------

`Migration API <https://www.elastic.co/guide/en/elasticsearch/reference/7.x/migration-api.html>`_
helps simplify upgrading X-Pack indices from one version to another.

.. py:module:: elasticsearch.client.migration

.. autoclass:: MigrationClient
   :members:


Enrich APIs
------------

`Enrich API <https://www.elastic.co/guide/en/elasticsearch/reference/7.x/enrich-apis.html>`_
can be used to add data from your existing indices to incoming documents during ingest.

.. py:module:: elasticsearch.client.enrich

.. autoclass:: EnrichClient
   :members:

SQL APIs
--------

The `SQL REST API <https://www.elastic.co/guide/en/elasticsearch/reference/7.x/sql-rest.html>`_
accepts SQL in a JSON document, executes it, and returns the results.

.. py:module:: elasticsearch.client.sql

.. autoclass:: SqlClient
   :members:

Cross-Cluster Replication APIs
-------------------------------

`Cross-Cluster Replication API <https://www.elastic.co/guide/en/elasticsearch/reference/7.x/ccr-apis.html>`_
used to perform cross-cluster replication operations.

.. py:module:: elasticsearch.client.ccr

.. autoclass:: CcrClient
   :members:


Monitoring APIs
----------------

`Monitoring API <https://www.elastic.co/guide/en/elasticsearch/reference/7.x/es-monitoring.html>`_
used to collect data from the Elasticsearch nodes, Logstash nodes, Kibana instances, and Beats in your cluster.

.. py:module:: elasticsearch.client.monitoring

.. autoclass:: MonitoringClient
   :members:


Rollup APIs
------------

`Rollup API <https://www.elastic.co/guide/en/elasticsearch/reference/7.x/rollup-apis.html>`_
enables searching through rolled-up data using the standard query DSL.

.. py:module:: elasticsearch.client.rollup

.. autoclass:: RollupClient
   :members:


Snapshot Lifecycle Management APIs
-----------------------------------

`Snapshot Lifecycle Management API <https://www.elastic.co/guide/en/elasticsearch/reference/7.x/snapshot-lifecycle-management-api.html>`_
can be used to set up policies to automatically take snapshots and control how long they are retained.

.. py:module:: elasticsearch.client.slm

.. autoclass:: SlmClient
   :members:


Searchable Snapshots APIs
-------------------------

`Searchable Snapshots API <https://www.elastic.co/guide/en/elasticsearch/reference/7.x/searchable-snapshots-apis.html>`_
used to perform searchable snapshots operations.

.. py:module:: elasticsearch.client.searchable_snapshots

.. autoclass:: SearchableSnapshotsClient
   :members:


Index Lifecycle Management APIs
--------------------------------

`Index Lifecycle Management API <https://www.elastic.co/guide/en/elasticsearch/reference/7.x/index-lifecycle-management-api.html>`_
used to set up policies to automatically manage the index lifecycle.

.. py:module:: elasticsearch.client.ilm

.. autoclass:: IlmClient
   :members:


Transform APIs
---------------

`Transform API <https://www.elastic.co/guide/en/elasticsearch/reference/7.x/transform-apis.html>`_
manages transformation operations from grabbing data from source indices, transforms it, and
saves it to a destination index.

.. py:module:: elasticsearch.client.transform

.. autoclass:: TransformClient
   :members:


Deprecation APIs
-----------------

`Deprecation API <https://www.elastic.co/guide/en/elasticsearch/reference/7.x/migration-api-deprecation.html>`_
used to retrieve information about different cluster, node, and index level settings that use deprecated features
that will be removed or changed in the next major version.

.. py:module:: elasticsearch.client.deprecation

.. autoclass:: DeprecationClient
   :members: