OpenSearch/docs/en/rest-api/license/get-basic-status.asciidoc
Tim Brooks 7f7ac08447 Add api to start basic license (elastic/x-pack-elasticsearch#4083)
This is related to elastic/x-pack-elasticsearch#3877. This commit adds a route /start_basic that
will self generate a basic license. The only validation that is
performed is to check that you do not already have a basic license
installed. Additionally, if you lose features from switching to a basic
license, you must acknowledge the changes.

Original commit: elastic/x-pack-elasticsearch@7b8eeb50b1
2018-03-12 14:39:58 -06:00

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/]