X-Pack

class elasticsearch.client.XPackClient

To use this client, access client.x_pack from an Elasticsearch client. For example:

from elasticsearch import Elasticsearch

# Create the client instance
client = Elasticsearch(...)
# Use the x_pack client
client.x_pack.<method>(...)

info(*, accept_enterprise=None, categories=None, error_trace=None, filter_path=None, human=None, pretty=None)

Get information. The information provided by the API includes:

Build information including the build number and timestamp.
License information about the currently installed license.
Feature information for the features that are currently enabled and available under the current license.

https://www.elastic.co/guide/en/elasticsearch/reference/8.17/info-api.html

Parameters:

accept_enterprise (bool | None) – If this param is used it must be set to true
categories (Sequence[str | Literal['build', 'features', 'license']] | None) – A comma-separated list of the information categories to include in the response. For example, build,license,features.
error_trace (bool | None)
filter_path (str | Sequence[str] | None)
human (bool | None)
pretty (bool | None)

Return type:

ObjectApiResponse[Any]

usage(*, error_trace=None, filter_path=None, human=None, master_timeout=None, pretty=None)

Get usage information. Get information about the features that are currently enabled and available under the current license. The API also provides some usage statistics.

https://www.elastic.co/guide/en/elasticsearch/reference/8.17/usage-api.html

Parameters:

master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – The period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. To indicate that the request should never timeout, set it to -1.
error_trace (bool | None)
filter_path (str | Sequence[str] | None)
human (bool | None)
pretty (bool | None)

Return type:

ObjectApiResponse[Any]