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.13/delete-license.html

Parameters:
Return type:

ObjectApiResponse[Any]

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.13/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) –

  • filter_path (str | Sequence[str] | 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.13/get-basic-status.html

Parameters:
Return type:

ObjectApiResponse[Any]

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.13/get-trial-status.html

Parameters:
Return type:

ObjectApiResponse[Any]

post(*, acknowledge=None, error_trace=None, filter_path=None, human=None, license=None, licenses=None, pretty=None, body=None)

Updates the license for the cluster.

https://www.elastic.co/guide/en/elasticsearch/reference/8.13/update-license.html

Parameters:

  • acknowledge (bool | None) – Specifies whether you acknowledge the license changes.

  • license (Mapping[str, Any] | None) –

  • licenses (Sequence[Mapping[str, Any]] | None) – A sequence of one or more JSON documents containing the license information.

  • error_trace (bool | None) –

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

  • human (bool | None) –

  • pretty (bool | None) –

  • body (Dict[str, Any] | None) –

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.13/start-basic.html

Parameters:

  • acknowledge (bool | None) – whether the user has acknowledged acknowledge messages (default: false)

  • error_trace (bool | None) –

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

  • human (bool | None) –

  • pretty (bool | None) –

Return type:

ObjectApiResponse[Any]

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.13/start-trial.html

Parameters:

  • acknowledge (bool | None) – whether the user has acknowledged acknowledge messages (default: false)

  • type_query_string (str | None) –

  • error_trace (bool | None) –

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

  • human (bool | None) –

  • pretty (bool | None) –

Return type:

ObjectApiResponse[Any]