NAME
Search::Elasticsearch::Client::8_0::Direct::License - Plugin providing License API for Search::Elasticsearch 8.x
VERSION
version 8.12
SYNOPSIS
my $response = $es->license->get();
DESCRIPTION
This class extends the Search::Elasticsearch client with a license
namespace, to support the API for the License plugin for Elasticsearch.
METHODS
The full documentation for the License plugin is available here: https://www.elastic.co/guide/en/x-pack/current/license-management.html
get()
$response = $es->license->get()
The get()
method returns the currently installed license.
See the license.get docs for more information.
Query string parameters: error_trace
, human
, local
post()
$response = $es->license->post(
body => {...} # required
);
The post()
method adds or updates the license for the cluster. The body
can be passed as JSON or as a string.
See the license.put docs for more information.
Query string parameters: acknowledge
, error_trace
, human
get_basic_status()
$response = $es->license->get_basic_status()
This API enables you to check the status of your basic license.
Query string parameters: error_trace
, filter_path
, human
See the get-basic-status docs for more.
post_start_basic()
$response = $es->license->post_start_basic()
This API enables you to initiate an indefinite basic license, which gives access to all the basic features.
Query string parameters: acknowledge
, error_trace
, filter_path
, human
See the post-start-basic docs for more.
get_trial_status()
$response = $es->license->get_trial_status()
This API enables you to check the status of your trial license.
Query string parameters: error_trace
, filter_path
, human
See the get-trial-status docs for more.
post_start_trial()
$response = $es->license->post_start_trial()
This API enables you to upgrade from a basic license to a 30-day trial license, which gives access to the platinum features.
Query string parameters: acknowledge
, error_trace
, filter_path
, human
See the post-start-trial docs for more.
AUTHOR
Enrico Zimuel <enrico.zimuel@elastic.co>
COPYRIGHT AND LICENSE
This software is Copyright (c) 2024 by Elasticsearch BV.
This is free software, licensed under:
The Apache License, Version 2.0, January 2004