OpenSearch/docs/reference/licensing/start-trial.asciidoc

58 lines
1.5 KiB
Plaintext

[role="xpack"]
[testenv="basic"]
[[start-trial]]
=== Start trial API
++++
<titleabbrev>Start trial</titleabbrev>
++++
Starts a 30-day trial.
[float]
==== Request
`POST /_license/start_trial`
[float]
==== Description
The `start trial` API enables you to start a 30-day trial, which gives access to
all subscription features.
NOTE: 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 {extendtrial}.
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
You must have `manage` cluster privileges to use this API.
For more information, see
<<security-privileges>>.
[float]
==== Examples
The following example starts a 30-day trial. The acknowledge parameter is
required as you are initiating a license that will expire.
[source,console]
------------------------------------------------------------
POST /_license/start_trial?acknowledge=true
------------------------------------------------------------
// TEST[skip:license testing issues]
Example response:
[source,js]
------------------------------------------------------------
{
"trial_was_started": true,
"acknowledged": true
}
------------------------------------------------------------
// NOTCONSOLE