elasticsearch/docs/reference/licensing/get-license.asciidoc

[role="xpack"]
[[get-license]]
=== Get license API
++++
<titleabbrev>Get license</titleabbrev>
++++

This API enables you to retrieve licensing information.

[discrete]
==== Request

`GET /_license`

[discrete]
==== Description

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.

NOTE: If the master node is generating a new cluster state, the get license API
may return a `404 Not Found` response. If you receive an unexpected `404`
response after cluster startup, wait a short period and retry the request. 

[discrete]
==== Query Parameters

`local`::
  (Boolean) Specifies whether to retrieve local information. The default value
  is `false`, which means the information is retrieved from the master node.
  
 `accept_enterprise`::
(Boolean) If `true`, this parameter returns `enterprise` for Enterprise
license types. If `false`, this parameter returns `platinum` for both
`platinum` and `enterprise` license types. This behavior is maintained for
backwards compatibility.
   
deprecated::[7.6.0,"This parameter is deprecated and will always be set to `true` in 8.x."]

[discrete]
==== Authorization

You must have `monitor` cluster privileges to use this API.
For more information, see <<security-privileges>>.


[discrete]
==== Examples

The following example provides information about a trial license:

[source,console]
--------------------------------------------------
GET /_license
--------------------------------------------------

[source,console-result]
--------------------------------------------------
{
  "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,
    "max_resource_units" : null,
    "issued_to" : "test",
    "issuer" : "elasticsearch",
    "start_date_in_millis" : -1
  }
}
--------------------------------------------------
// TESTRESPONSE[s/"cbff45e7-c553-41f7-ae4f-9205eabd80xx"/$body.license.uid/]
// TESTRESPONSE[s/"basic"/$body.license.type/]
// TESTRESPONSE[s/"2018-10-20T22:05:12.332Z"/$body.license.issue_date/]
// TESTRESPONSE[s/1540073112332/$body.license.issue_date_in_millis/]
// TESTRESPONSE[s/"2018-11-19T22:05:12.332Z"/$body.license.expiry_date/]
// TESTRESPONSE[s/1542665112332/$body.license.expiry_date_in_millis/]
// TESTRESPONSE[s/1000/$body.license.max_nodes/]
// TESTRESPONSE[s/"test"/$body.license.issued_to/]
// TESTRESPONSE[s/"elasticsearch"/$body.license.issuer/]