OpenSearch/docs/reference/licensing/get-trial-status.asciidoc

54 lines
1.4 KiB
Plaintext

[role="xpack"]
[testenv="basic"]
[[get-trial-status]]
=== Get trial status API
++++
<titleabbrev>Get trial status</titleabbrev>
++++
Enables you to check the status of your trial.
[float]
==== Request
`GET /_license/trial_status`
[float]
==== Description
If you want to try all the subscription features, you can start a 30-day trial.
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}.
For more information about features and subscriptions, see
https://www.elastic.co/subscriptions.
==== Authorization
You must have `monitor` cluster privileges to use this API.
For more information, see
<<security-privileges>>.
[float]
==== Examples
The following example checks whether you are eligible to start a trial:
[source,console]
------------------------------------------------------------
GET /_license/trial_status
------------------------------------------------------------
Example response:
[source,console-result]
------------------------------------------------------------
{
"eligible_to_start_trial": true
}
------------------------------------------------------------
// TESTRESPONSE[s/"eligible_to_start_trial": true/"eligible_to_start_trial": $body.eligible_to_start_trial/]