X-Pack

class elasticsearch.client.XPackClient(client)

Parameters:

client (BaseClient)

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

Provides general information about the installed X-Pack features.

https://www.elastic.co/guide/en/elasticsearch/reference/8.16/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)

This API provides information about which features are currently enabled and available under the current license and some usage statistics.

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

Parameters:

• master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – 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.

• error_trace (bool | None)

• filter_path (str | Sequence[str] | None)

• human (bool | None)

• pretty (bool | None)

Return type:

ObjectApiResponse[Any]