Get license information
- GET /_license
Get information about your Elastic license including its type, its status, when it was issued, and when it expires.
info If the master node is generating a new cluster state, the get license API may return a
404 Not Foundresponse. If you receive an unexpected 404 response after cluster startup, wait a short period and retry the request.
Query Parameters
-
accept_enterpriseboolean · default: truedeprecated If
true, this parameter returns enterprise for Enterprise license types. Iffalse, this parameter returns platinum for both platinum and enterprise license types. This behavior is maintained for backwards compatibility. This parameter is deprecated and will always be set to true in 8.x.-
localboolean · default: true Specifies whether to retrieve local information. From 9.2 onwards the default value is
true, which means the information is retrieved from the responding node. In earlier versions the default isfalse, which means the information is retrieved from the elected master node.
Response
-
licenseLicenseInformationrequired -
expiry_dateDateTime -
The date and time the license expires in ISO 8601 format.
-
expiry_date_in_millisEpochTimeUnitMillis -
The date and time the license expires in milliseconds since the Unix epoch.
-
issue_dateDateTimerequired -
The date and time the license was issued in ISO 8601 format.
-
issue_date_in_millisEpochTimeUnitMillisrequired -
The date and time the license was issued in milliseconds since the Unix epoch.
-
issued_tostringrequired -
The name of the customer or organization that received the license.
-
issuerstringrequired -
The name of the organization that issued the license.
-
max_nodesnumber | stringrequired nullable -
The maximum number of nodes the license allows.
-
max_resource_unitsnumber | stringnullable -
The maximum number of resource units the license allows (for enterprise licenses only).
-
statusLicenseStatusrequired -
The status of the license. For example,active, valid, invalid, or expired.
-
Values:
activevalidinvalidexpired -
typeLicenseTyperequired -
The type of the license. For example, trial, basic, gold, platinum, or enterprise.
-
Values:
missingtrialbasicstandarddevsilvergoldplatinumenterprise -
uidstringrequired -
The unique identifier of the license.
-
start_date_in_millisEpochTimeUnitMillisrequired -
The date and time the license was started in milliseconds since the Unix epoch.