Start a trial Generally available; Added in 6.1.0

View as markdown
POST /_license/start_trial
Api key auth Basic auth Bearer auth

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

  • Cluster privileges: manage

Query parameters

  • acknowledge boolean

    whether the user has acknowledged acknowledge messages (default: false)

  • type string

    The type of trial license to generate (default: "trial")

  • master_timeout string

    Period to wait for a connection to the master node.

    External documentation

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • acknowledged boolean Required
    • error_message string
    • trial_was_started boolean Required
    • type string

      Values are missing, trial, basic, standard, dev, silver, gold, platinum, or enterprise.
POST /_license/start_trial 
POST /_license/start_trial?acknowledge=true

resp = client.license.post_start_trial(
    acknowledge=True,
)
const response = await client.license.postStartTrial({
  acknowledge: "true",
});
response = client.license.post_start_trial(
  acknowledge: "true"
)
$resp = $client->license()->postStartTrial([
    "acknowledge" => "true",
]);
curl -X POST -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_license/start_trial?acknowledge=true"
client.license().postStartTrial(p -> p
    .acknowledge(true)
);
Response examples (200)
A successful response from `POST /_license/start_trial?acknowledge=true`. 
{
  "trial_was_started": true,
  "acknowledged": true
}