Update the license

  • POST also PUT /_license
Auth

You can update your license at runtime without shutting down your nodes. License updates take effect immediately. If the license you are installing does not support all of the features that were available with your previous license, however, you are notified in the response. You must then re-submit the API request with the acknowledge parameter set to true.

Note

If Elasticsearch security features are enabled and you are installing a gold or higher license, you must enable TLS on the transport networking layer before you install the license. If the operator privileges feature is enabled, only operator users can use this API.

Required authorization

Cluster privileges manage

Query parameters

acknowledge boolean · default: false

Specifies whether you acknowledge the license changes.

master_timeout string · default: 30s

The period to wait for a connection to the master node.

timeout string · default: 30s

The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

Request body

license object
expiry_date_in_millis number required
issue_date_in_millis number required
start_date_in_millis number
issued_to string required
issuer string required
max_nodes union number | string nullable
max_resource_units number
signature string required
type enum required
Values: missing trial basic standard dev silver gold platinum enterprise
uid string required
licenses object[]

A sequence of one or more JSON documents containing the license information.

Same fields as license

Response

application/json
acknowledge object
license string[] required
message string required
acknowledged boolean required
license_status enum required
Values: active valid invalid expired