New

The executive guide to generative AI

Read more
About usPartnersSupport|Login
IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Start trial API Start basic API »
Elastic Docs ›Elasticsearch Guide [7.13] ›REST APIs ›Licensing APIs

Get basic status API

edit
IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

Get basic status API

edit

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

Request

edit

GET /_license/basic_status

Description

edit

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

edit

You must have monitor cluster privileges to use this API. For more information, see Security privileges.

Examples

edit

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

GET /_license/basic_status
Copy as curlTry in Elastic 

Example response:

{
  "eligible_to_start_basic": true
}
« Start trial API Start basic API »
Was this helpful?
Feedback