46 lines
1.1 KiB
Plaintext
46 lines
1.1 KiB
Plaintext
|
[role="xpack"]
|
||
|
|
[[get-basic-status]]
|
||
|
|
=== Get Basic Status API
|
||
|
|
|
||
|
|
This API enables you to check the status of your basic license.
|
||
|
|
|
||
|
|
[float]
|
||
|
|
==== Request
|
||
|
|
|
||
|
|
`GET _xpack/license/basic_status`
|
||
|
|
|
||
|
|
[float]
|
||
|
|
==== Description
|
||
|
|
|
||
|
|
In order to initiate a basic license, you must not currently have a basic
|
||
|
|
license.
|
||
|
|
|
||
|
|
For more information about the different types of licenses, see
|
||
|
|
https://www.elastic.co/subscriptions.
|
||
|
|
|
||
|
|
==== Authorization
|
||
|
|
|
||
|
|
You must have `monitor` cluster privileges to use this API.
|
||
|
|
For more information, see
|
||
|
|
{xpack-ref}/security-privileges.html[Security Privileges].
|
||
|
|
|
||
|
|
[float]
|
||
|
|
==== Examples
|
||
|
|
|
||
|
|
The following example checks whether you are eligible to start a basic:
|
||
|
|
|
||
|
|
[source,js]
|
||
|
|
------------------------------------------------------------
|
||
|
|
GET _xpack/license/basic_status
|
||
|
|
------------------------------------------------------------
|
||
|
|
// CONSOLE
|
||
|
|
|
||
|
|
Example response:
|
||
|
|
[source,js]
|
||
|
|
------------------------------------------------------------
|
||
|
|
{
|
||
|
|
"eligible_to_start_basic": true
|
||
|
|
}
|
||
|
|
------------------------------------------------------------
|
||
|
|
// TESTRESPONSE[s/"eligible_to_start_basic": true/"eligible_to_start_basic": $body.eligible_to_start_basic/]
|