This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.

« Get trial status API Get basic status API »

› › ›

Start trial API

edit

Start trial API

edit

Starts a 30-day trial.

Request

edit

POST /_license/start_trial

Description

edit

The start trial API enables you to start a 30-day trial, which gives access to all subscription features.

You are allowed to initiate 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 v6.0, you cannot start a new trial until v7.0. You can, however, request an extended trial at https://www.elastic.co/trialextension.

To check the status of your trial, use Get trial status.

For more information about features and subscriptions, see https://www.elastic.co/subscriptions.

Authorization

edit

You must have manage cluster privileges to use this API. For more information, see Security privileges.

Examples

edit

The following example starts a 30-day trial. The acknowledge parameter is required as you are initiating a license that will expire.

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

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

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

POST /_license/start_trial?acknowledge=true

Example response:

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

« Get trial status API Get basic status API »