75 lines
2.1 KiB
Plaintext
75 lines
2.1 KiB
Plaintext
[role="xpack"]
|
|
[testenv="basic"]
|
|
[[start-basic]]
|
|
=== Start Basic API
|
|
|
|
This API starts an indefinite basic license.
|
|
|
|
[float]
|
|
==== Request
|
|
|
|
`POST _xpack/license/start_basic`
|
|
|
|
[float]
|
|
==== Description
|
|
|
|
The `start basic` API enables you to initiate an indefinite basic license, which
|
|
gives access to all {xpack} basic features. If the basic license does not support
|
|
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
|
|
{xpack-ref}/security-privileges.html[Security Privileges].
|
|
|
|
[float]
|
|
==== Examples
|
|
|
|
The following example starts a basic license if you do not currently have a license:
|
|
|
|
[source,js]
|
|
------------------------------------------------------------
|
|
POST _xpack/license/start_basic
|
|
------------------------------------------------------------
|
|
// CONSOLE
|
|
// 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:
|
|
|
|
[source,js]
|
|
------------------------------------------------------------
|
|
POST _xpack/license/start_basic?acknowledge=true
|
|
------------------------------------------------------------
|
|
// CONSOLE
|
|
// TEST[skip:license testing issues]
|
|
|
|
Example response:
|
|
[source,js]
|
|
------------------------------------------------------------
|
|
{
|
|
"basic_was_started": true,
|
|
"acknowledged": true
|
|
}
|
|
------------------------------------------------------------
|
|
// NOTCONSOLE |