Get Basic Status API

This API enables you to check the status of your basic license.

Request

GET _xpack/license/basic_status

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.

Examples

The following example checks whether you are eligible to start a basic:

GET _xpack/license/basic_status

Example response:

{
  "eligible_to_start_basic": true
}