Get license information

  • GET /_license
Auth

Get information about your Elastic license including its type, its status, when it was issued, and when it expires.

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.

Query parameters

accept_enterprise boolean · default: true deprecated

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. This parameter is deprecated and will always be set to true in 8.x.

local boolean · 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 is false, which means the information is retrieved from the elected master node.

Response

application/json
license object required
expiry_date union oneOf

The date and time the license expires in ISO 8601 format.

One of: string or number
expiry_date_in_millis number

The date and time the license expires in milliseconds since the Unix epoch.

issue_date union oneOf required

The date and time the license was issued in ISO 8601 format.

One of: string or number
issue_date_in_millis number required

The date and time the license was issued in milliseconds since the Unix epoch.

issued_to string required

The name of the customer or organization that received the license.

issuer string required

The name of the organization that issued the license.

max_nodes union number | string required nullable

The maximum number of nodes the license allows.

max_resource_units union number | string nullable

The maximum number of resource units the license allows (for enterprise licenses only).

status enum required

The status of the license. For example,active, valid, invalid, or expired.

Values: active valid invalid expired
type enum required

The type of the license. For example, trial, basic, gold, platinum, or enterprise.

Values: missing trial basic standard dev silver gold platinum enterprise
uid string required

The unique identifier of the license.

start_date_in_millis number required

The date and time the license was started in milliseconds since the Unix epoch.