License
- class elasticsearch.client.LicenseClient(client)
- Parameters:
client (BaseClient) –
- delete(*, error_trace=None, filter_path=None, human=None, pretty=None)
Deletes licensing information for the cluster
https://www.elastic.co/guide/en/elasticsearch/reference/8.11/delete-license.html
- get(*, accept_enterprise=None, error_trace=None, filter_path=None, human=None, local=None, pretty=None)
Retrieves licensing information for the cluster
https://www.elastic.co/guide/en/elasticsearch/reference/8.11/get-license.html
- Parameters:
accept_enterprise (bool | None) – If true, this parameter returns enterprise for Enterprise license types. If false, this parameter returns platinum for both platinum and enterprise license types. This behavior is maintained for backwards compatibility. This parameter is deprecated and will always be set to true in 8.x.
local (bool | None) – Specifies whether to retrieve local information. The default value is false, which means the information is retrieved from the master node.
error_trace (bool | None) –
human (bool | None) –
pretty (bool | None) –
- Return type:
ObjectApiResponse[Any]
- get_basic_status(*, error_trace=None, filter_path=None, human=None, pretty=None)
Retrieves information about the status of the basic license.
https://www.elastic.co/guide/en/elasticsearch/reference/8.11/get-basic-status.html
- get_trial_status(*, error_trace=None, filter_path=None, human=None, pretty=None)
Retrieves information about the status of the trial license.
https://www.elastic.co/guide/en/elasticsearch/reference/8.11/get-trial-status.html
- post(*, acknowledge=None, error_trace=None, filter_path=None, human=None, license=None, licenses=None, pretty=None)
Updates the license for the cluster.
https://www.elastic.co/guide/en/elasticsearch/reference/8.11/update-license.html
- Parameters:
- Return type:
ObjectApiResponse[Any]
- post_start_basic(*, acknowledge=None, error_trace=None, filter_path=None, human=None, pretty=None)
Starts an indefinite basic license.
https://www.elastic.co/guide/en/elasticsearch/reference/8.11/start-basic.html
- post_start_trial(*, acknowledge=None, error_trace=None, filter_path=None, human=None, pretty=None, type_query_string=None)
starts a limited time trial license.
https://www.elastic.co/guide/en/elasticsearch/reference/8.11/start-trial.html