Start a trial

POST /_license/start_trial

Start a 30-day trial, which gives access to all subscription features.

Note

You are allowed to start a trial only if your cluster has not already activated a trial for the current major product version. For example, if you have already activated a trial for v8.0, you cannot start a new trial until v9.0. You can, however, request an extended trial at https://www.elastic.co/trialextension.

To check the status of your trial, use the get trial status API.

Required authorization

Authentication

Api key

Authorization: <value>

Elasticsearch APIs support key-based authentication. You must create an API key and use the encoded value in the request header. For example:

		curl -X GET "${ES_URL}/_cat/indices?v=true" \
  -H "Authorization: ApiKey ${API_KEY}"

To get API keys, use the /_security/api_key APIs.

Basic

Authorization: Basic <credentials>

Bearer

Authorization: Bearer <token>

Elasticsearch APIs support the use of bearer tokens in the Authorization HTTP header to authenticate with the API. For examples, refer to Token-based authentication services

Query parameters

Response

application/json

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

POST /_license/start_trial?acknowledge=true

JavaScript Elasticsearch JavaScript Client

const response = await client.license.postStartTrial({
  acknowledge: "true",
});

Python Elasticsearch Python Client

resp = client.license.post_start_trial(
    acknowledge=True,
)

curl Shell

curl -X POST "$ELASTICSEARCH_URL/_license/start_trial?acknowledge=true" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.license().postStartTrial(p -> p
    .acknowledge(true)
);

C# Elasticsearch .NET Client

var response = await client.LicenseManagement
    .PostStartTrialAsync(d1 => d1
        .Acknowledge(true)
    );

PHP Elasticsearch PHP Client

$resp = $client->license()->postStartTrial([
    "acknowledge" => "true",
]);

Ruby Elasticsearch Ruby Client

response = client.license.post_start_trial(
  acknowledge: "true"
)

Response

A successful response from POST /_license/start_trial?acknowledge=true.

{
  "trial_was_started": true,
  "acknowledged": true
}