mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-04-25 07:37:19 -04:00
f56a0f4b66
Removes `testenv` annotations and related code. These annotations originally let you skip x-pack snippet tests in the docs. However, that's no longer possible. Relates to #79309, #31619
47 lines
1.1 KiB
Text
47 lines
1.1 KiB
Text
[role="xpack"]
|
|
[[get-basic-status]]
|
|
=== Get basic status API
|
|
++++
|
|
<titleabbrev>Get basic status</titleabbrev>
|
|
++++
|
|
|
|
This API enables you to check the status of your basic license.
|
|
|
|
[discrete]
|
|
==== Request
|
|
|
|
`GET /_license/basic_status`
|
|
|
|
[discrete]
|
|
==== 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 <<security-privileges>>.
|
|
|
|
[discrete]
|
|
==== Examples
|
|
|
|
The following example checks whether you are eligible to start a basic:
|
|
|
|
[source,console]
|
|
------------------------------------------------------------
|
|
GET /_license/basic_status
|
|
------------------------------------------------------------
|
|
|
|
Example response:
|
|
|
|
[source,console-result]
|
|
------------------------------------------------------------
|
|
{
|
|
"eligible_to_start_basic": true
|
|
}
|
|
------------------------------------------------------------
|
|
// TESTRESPONSE[s/"eligible_to_start_basic": true/"eligible_to_start_basic": $body.eligible_to_start_basic/]
|