2018-03-12 16:39:58 -04:00
|
|
|
[role="xpack"]
|
2018-06-20 11:17:11 -04:00
|
|
|
[testenv="basic"]
|
2018-03-12 16:39:58 -04:00
|
|
|
[[start-basic]]
|
2018-12-20 13:23:28 -05:00
|
|
|
=== Start basic API
|
|
|
|
++++
|
|
|
|
<titleabbrev>Start basic</titleabbrev>
|
|
|
|
++++
|
2018-03-12 16:39:58 -04:00
|
|
|
|
|
|
|
This API starts an indefinite basic license.
|
|
|
|
|
2020-07-23 12:42:33 -04:00
|
|
|
[discrete]
|
2018-03-12 16:39:58 -04:00
|
|
|
==== Request
|
|
|
|
|
2018-11-28 08:24:35 -05:00
|
|
|
`POST /_license/start_basic`
|
2018-03-12 16:39:58 -04:00
|
|
|
|
2020-07-23 12:42:33 -04:00
|
|
|
[discrete]
|
2018-03-12 16:39:58 -04:00
|
|
|
==== Description
|
|
|
|
|
|
|
|
The `start basic` API enables you to initiate an indefinite basic license, which
|
2018-06-28 18:38:41 -04:00
|
|
|
gives access to all the basic features. If the basic license does not support
|
2018-03-12 16:39:58 -04:00
|
|
|
all of the features that are available with your current license, however, you are
|
|
|
|
notified in the response. You must then re-submit the API request with the
|
|
|
|
`acknowledge` parameter set to `true`.
|
|
|
|
|
|
|
|
To check the status of your basic license, use the following API:
|
|
|
|
<<get-basic-status>>.
|
|
|
|
|
|
|
|
For more information about the different types of licenses, see
|
|
|
|
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-12 16:39:58 -04:00
|
|
|
|
2020-07-23 12:42:33 -04:00
|
|
|
[discrete]
|
2018-03-12 16:39:58 -04:00
|
|
|
==== Examples
|
|
|
|
|
|
|
|
The following example starts a basic license if you do not currently have a license:
|
|
|
|
|
2019-09-06 11:31:13 -04:00
|
|
|
[source,console]
|
2018-03-12 16:39:58 -04:00
|
|
|
------------------------------------------------------------
|
2018-11-28 08:24:35 -05:00
|
|
|
POST /_license/start_basic
|
2018-03-12 16:39:58 -04:00
|
|
|
------------------------------------------------------------
|
|
|
|
// TEST[skip:license testing issues]
|
|
|
|
|
|
|
|
Example response:
|
|
|
|
[source,js]
|
|
|
|
------------------------------------------------------------
|
|
|
|
{
|
|
|
|
"basic_was_started": true,
|
|
|
|
"acknowledged": true
|
|
|
|
}
|
|
|
|
------------------------------------------------------------
|
|
|
|
// NOTCONSOLE
|
|
|
|
|
|
|
|
The following example starts a basic license if you currently have a license with more
|
|
|
|
features than a basic license. As you are losing features, you must pass the acknowledge
|
|
|
|
parameter:
|
|
|
|
|
2019-09-06 11:31:13 -04:00
|
|
|
[source,console]
|
2018-03-12 16:39:58 -04:00
|
|
|
------------------------------------------------------------
|
2018-11-28 08:24:35 -05:00
|
|
|
POST /_license/start_basic?acknowledge=true
|
2018-03-12 16:39:58 -04:00
|
|
|
------------------------------------------------------------
|
|
|
|
// TEST[skip:license testing issues]
|
|
|
|
|
|
|
|
Example response:
|
|
|
|
[source,js]
|
|
|
|
------------------------------------------------------------
|
|
|
|
{
|
|
|
|
"basic_was_started": true,
|
|
|
|
"acknowledged": true
|
|
|
|
}
|
|
|
|
------------------------------------------------------------
|
|
|
|
// NOTCONSOLE
|