NOTE: You are looking at documentation for an older release. For the latest information, see the current release documentation.

« Delete license API Get trial status API »

› › ›

Get license API

edit

Get license API

edit

This API enables you to retrieve licensing information.

Request

edit

GET /_xpack/license

Description

edit

This API returns information about the type of license, when it was issued, and when it expires, for example.

For more information about the different types of licenses, see https://www.elastic.co/subscriptions.

Query Parameters

edit

local: (boolean) Specifies whether to retrieve local information. The default value is false, which means the information is retrieved from the master node.

Authorization

edit

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

Examples

edit

The following example provides information about a trial license:

GET _xpack/license

{
  "license" : {
    "status" : "active",
    "uid" : "cbff45e7-c553-41f7-ae4f-9205eabd80xx",
    "type" : "trial",
    "issue_date" : "2018-10-20T22:05:12.332Z",
    "issue_date_in_millis" : 1540073112332,
    "expiry_date" : "2018-11-19T22:05:12.332Z",
    "expiry_date_in_millis" : 1542665112332,
    "max_nodes" : 1000,
    "issued_to" : "test",
    "issuer" : "elasticsearch",
    "start_date_in_millis" : -1
  }
}

« Delete license API Get trial status API »