|
| 1 | +.. _xpack: |
| 2 | + |
| 3 | +X-Pack APIs |
| 4 | +=========== |
| 5 | + |
| 6 | +X-Pack is an Elastic Stack extension that bundles security, alerting, monitoring, |
| 7 | +reporting, and graph capabilities into one easy-to-install package. |
| 8 | +While the X-Pack components are designed to work together seamlessly, you can |
| 9 | +easily enable or disable the features you want to use. |
| 10 | + |
| 11 | + |
| 12 | + |
| 13 | +Info |
| 14 | +---- |
| 15 | + |
| 16 | +`X-Pack info <https://www.elastic.co/guide/en/elasticsearch/reference/6.2/info-api.html>`_ |
| 17 | +provides general info about the installed X-Pack. |
| 18 | + |
| 19 | +.. py:module:: elasticsearch.client.xpack |
| 20 | +
|
| 21 | +.. autoclass:: XPackClient |
| 22 | + :members: |
| 23 | + |
| 24 | + |
| 25 | +Graph Explore |
| 26 | +------------- |
| 27 | +`X-Pack Graph Explore <https://www.elastic.co/guide/en/elasticsearch/reference/6.2/graph-explore-api.html>`_ |
| 28 | +enables you to extract and summarize information about the documents and terms in your Elasticsearch index. |
| 29 | + |
| 30 | +.. py:module:: elasticsearch.client.xpack.graph |
| 31 | +
|
| 32 | +
|
| 33 | +.. autoclass:: GraphClient |
| 34 | + :members: |
| 35 | + |
| 36 | +Licensing API |
| 37 | +------------- |
| 38 | + |
| 39 | +`Licensing API <https://www.elastic.co/guide/en/elasticsearch/reference/6.2/licensing-apis.html>`_ |
| 40 | +can be used to manage your licences. |
| 41 | + |
| 42 | + |
| 43 | +.. py:module:: elasticsearch.client.xpack.license |
| 44 | +
|
| 45 | +
|
| 46 | +.. autoclass:: LicenseClient |
| 47 | + :members: |
| 48 | + |
| 49 | +Machine Learning APIs |
| 50 | +--------------------- |
| 51 | + |
| 52 | +`Machine Learning <https://www.elastic.co/guide/en/elasticsearch/reference/6.2/ml-apis.html>`_ |
| 53 | +can be useful for discovering new patterns about your data. For a more detailed explanation |
| 54 | +about X-Pack's machine learning please refer to the official documentation. |
| 55 | + |
| 56 | + |
| 57 | +.. py:module:: elasticsearch.client.xpack.ml |
| 58 | +
|
| 59 | +
|
| 60 | +.. autoclass:: MlClient |
| 61 | + :members: |
| 62 | + |
| 63 | +Security APIs |
| 64 | +------------- |
| 65 | + |
| 66 | +`Security API <https://www.elastic.co/guide/en/elasticsearch/reference/6.2/security-api.html>`_ |
| 67 | +can be used to help secure your Elasticsearch cluster. Integrating with LDAP and Active Directory. |
| 68 | + |
| 69 | +.. py:module:: elasticsearch.client.xpack.security |
| 70 | +
|
| 71 | +
|
| 72 | +.. autoclass:: SecurityClient |
| 73 | + :members: |
| 74 | + |
| 75 | +Watcher APIs |
| 76 | +------------- |
| 77 | + |
| 78 | +`Watcher API <https://www.elastic.co/guide/en/elasticsearch/reference/6.2/watcher-api.html>`_ |
| 79 | +can be used to notify you when certain pre-defined thresholds have happened. |
| 80 | + |
| 81 | +.. py:module:: elasticsearch.client.xpack.watcher |
| 82 | +
|
| 83 | +.. autoclass:: WatcherClient |
| 84 | + :members: |
| 85 | + |
| 86 | + |
| 87 | +Migration APIs |
| 88 | +--------------- |
| 89 | + |
| 90 | +`Migration API <https://www.elastic.co/guide/en/elasticsearch/reference/6.2/migration-api.html>`_ |
| 91 | +helps simplify upgrading X-Pack indices from one version to another. |
| 92 | + |
| 93 | +.. py:module:: elasticsearch.client.xpack.migration |
| 94 | +
|
| 95 | +.. autoclass:: MigrationClient |
| 96 | + :members: |
| 97 | + |
0 commit comments