2018-03-06 12:47:04 -05:00
|
|
|
[role="xpack"]
|
2018-06-20 11:17:11 -04:00
|
|
|
[testenv="basic"]
|
2018-03-06 12:47:04 -05:00
|
|
|
[[start-trial]]
|
2018-12-20 13:23:28 -05:00
|
|
|
=== Start trial API
|
|
|
|
++++
|
|
|
|
<titleabbrev>Start trial</titleabbrev>
|
|
|
|
++++
|
2018-03-06 12:47:04 -05:00
|
|
|
|
2020-07-09 15:24:45 -04:00
|
|
|
Starts a 30-day trial.
|
2018-03-06 12:47:04 -05:00
|
|
|
|
2020-07-23 12:42:33 -04:00
|
|
|
[discrete]
|
2018-03-06 12:47:04 -05:00
|
|
|
==== Request
|
|
|
|
|
2018-11-28 08:24:35 -05:00
|
|
|
`POST /_license/start_trial`
|
2018-03-06 12:47:04 -05:00
|
|
|
|
2020-07-23 12:42:33 -04:00
|
|
|
[discrete]
|
2018-03-06 12:47:04 -05:00
|
|
|
==== Description
|
|
|
|
|
2020-07-09 15:24:45 -04:00
|
|
|
The `start trial` API enables you to start a 30-day trial, which gives access to
|
|
|
|
all subscription features.
|
2018-03-06 12:47:04 -05:00
|
|
|
|
2020-07-09 15:24:45 -04:00
|
|
|
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}.
|
2018-03-06 12:47:04 -05:00
|
|
|
|
2020-07-09 15:24:45 -04:00
|
|
|
To check the status of your trial, use <<get-trial-status>>.
|
2018-03-06 12:47:04 -05:00
|
|
|
|
2020-07-09 15:24:45 -04:00
|
|
|
For more information about features and subscriptions, see
|
2018-03-06 12:47:04 -05:00
|
|
|
https://www.elastic.co/subscriptions.
|
|
|
|
|
|
|
|
==== Authorization
|
|
|
|
|
|
|
|
You must have `manage` cluster privileges to use this API.
|
|
|
|
For more information, see
|
2019-10-07 18:23:19 -04:00
|
|
|
<<security-privileges>>.
|
2018-03-06 12:47:04 -05:00
|
|
|
|
2020-07-23 12:42:33 -04:00
|
|
|
[discrete]
|
2018-03-06 12:47:04 -05:00
|
|
|
==== Examples
|
|
|
|
|
2020-07-09 15:24:45 -04:00
|
|
|
The following example starts a 30-day trial. The acknowledge parameter is
|
|
|
|
required as you are initiating a license that will expire.
|
2018-04-26 21:42:44 -04:00
|
|
|
|
2019-09-06 11:31:13 -04:00
|
|
|
[source,console]
|
2018-04-26 21:42:44 -04:00
|
|
|
------------------------------------------------------------
|
2018-11-28 08:24:35 -05:00
|
|
|
POST /_license/start_trial?acknowledge=true
|
2018-04-26 21:42:44 -04:00
|
|
|
------------------------------------------------------------
|
|
|
|
// TEST[skip:license testing issues]
|
|
|
|
|
|
|
|
Example response:
|
|
|
|
[source,js]
|
|
|
|
------------------------------------------------------------
|
|
|
|
{
|
|
|
|
"trial_was_started": true,
|
|
|
|
"acknowledged": true
|
|
|
|
}
|
|
|
|
------------------------------------------------------------
|
|
|
|
// NOTCONSOLE
|