Update the license

POST /_license

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.

Query parameters

acknowledge boolean

Specifies whether you acknowledge the license changes.

application/json

Body

license object

Additional properties are allowed.
Hide license attributes Show license attributes object
- expiry_date_in_millis number
  
  Time unit for milliseconds
- issue_date_in_millis number
  
  Time unit for milliseconds
- start_date_in_millis number
  
  Time unit for milliseconds
- issued_to string Required
- issuer string Required
- max_nodes number | string | null
  
  One of:
  number-1 number string-2 string | null
- max_resource_units number
- signature string Required
- type string Required
  
  Values are missing, trial, basic, standard, dev, silver, gold, platinum, or enterprise.
- uid string Required
licenses array[object]

A sequence of one or more JSON documents containing the license information.
Hide licenses attributes Show licenses attributes object
- expiry_date_in_millis number
  
  Time unit for milliseconds
- issue_date_in_millis number
  
  Time unit for milliseconds
- start_date_in_millis number
  
  Time unit for milliseconds
- issued_to string Required
- issuer string Required
- max_nodes number | string | null
  
  One of:
  number-1 number string-2 string | null
- max_resource_units number
- signature string Required
- type string Required
  
  Values are missing, trial, basic, standard, dev, silver, gold, platinum, or enterprise.
- uid string Required

Responses

200 application/json
Hide response attributes Show response attributes object
- acknowledge object
  
  Additional properties are allowed.
  
  Hide acknowledge attributes Show acknowledge attributes object
  
  license array[string] Required
  
  message string Required
- acknowledged boolean Required
- license_status string Required
  
  Values are active, valid, invalid, or expired.

POST /_license

curl \
 -X POST http://api.example.com/_license \
 -H "Content-Type: application/json" \
 -d '{"license":{"":42.0,"issued_to":"string","issuer":"string","max_nodes":42.0,"max_resource_units":42.0,"signature":"string","type":"missing","uid":"string"},"licenses":[{"":42.0,"issued_to":"string","issuer":"string","max_nodes":42.0,"max_resource_units":42.0,"signature":"string","type":"missing","uid":"string"}]}'

Request examples

{
  "license": {
    "": 42.0,
    "issued_to": "string",
    "issuer": "string",
    "max_nodes": 42.0,
    "max_resource_units": 42.0,
    "signature": "string",
    "type": "missing",
    "uid": "string"
  },
  "licenses": [
    {
      "": 42.0,
      "issued_to": "string",
      "issuer": "string",
      "max_nodes": 42.0,
      "max_resource_units": 42.0,
      "signature": "string",
      "type": "missing",
      "uid": "string"
    }
  ]
}

Response examples (200)

{
  "acknowledge": {
    "license": [
      "string"
    ],
    "message": "string"
  },
  "acknowledged": true,
  "license_status": "active"
}