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 privileges

Cluster privileges manage

Query parameters

acknowledge boolean · default: false: To update a license, you must accept the acknowledge messages and set this parameter to true. In particular, if you are upgrading or downgrading a license, you must acknowlege the feature changes.
master_timeout union oneOf · default: 30s: The period to wait for a connection to the master node.; Values: -1 0
timeout union oneOf · 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.; Values: -1 0

Request body

license object
licenses object[]: A sequence of one or more JSON documents containing the license information.; Same fields as license

Response

application/json

acknowledge object
acknowledged boolean required
license_status enum required: Values: active valid invalid expired

View as Markdown

Examples

Request Console 1 / 8 languages

Run POST _license to update to a basic license. NOTE: These values are invalid; you must substitute the appropriate contents from your license file.

Console Kibana Dev Tools

POST _license
{
  "licenses": [
    {
      "uid":"893361dc-9749-4997-93cb-802e3d7fa4xx",
      "type":"basic",
      "issue_date_in_millis":1411948800000,
      "expiry_date_in_millis":1914278399999,
      "max_nodes":1,
      "issued_to":"issuedTo",
      "issuer":"issuer",
      "signature":"xx"
    }
    ]
}

JavaScript Elasticsearch JavaScript Client

const response = await client.license.post({
  licenses: [
    {
      uid: "893361dc-9749-4997-93cb-802e3d7fa4xx",
      type: "basic",
      issue_date_in_millis: 1411948800000,
      expiry_date_in_millis: 1914278399999,
      max_nodes: 1,
      issued_to: "issuedTo",
      issuer: "issuer",
      signature: "xx",
    },
  ],
});

Python Elasticsearch Python Client

resp = client.license.post(
    licenses=[
        {
            "uid": "893361dc-9749-4997-93cb-802e3d7fa4xx",
            "type": "basic",
            "issue_date_in_millis": 1411948800000,
            "expiry_date_in_millis": 1914278399999,
            "max_nodes": 1,
            "issued_to": "issuedTo",
            "issuer": "issuer",
            "signature": "xx"
        }
    ],
)

curl Shell

curl -X POST "$ELASTICSEARCH_URL/_license" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "licenses": [
      {
        "uid": "893361dc-9749-4997-93cb-802e3d7fa4xx",
        "type": "basic",
        "issue_date_in_millis": 1411948800000,
        "expiry_date_in_millis": 1914278399999,
        "max_nodes": 1,
        "issued_to": "issuedTo",
        "issuer": "issuer",
        "signature": "xx"
      }
    ]
  }'

Java Elasticsearch Java Client

client.license().post(p -> p
    .licenses(l -> l
        .expiryDateInMillis(1914278399999L)
        .issueDateInMillis(1411948800000L)
        .issuedTo("issuedTo")
        .issuer("issuer")
        .maxNodes(1L)
        .signature("xx")
        .type(LicenseType.Basic)
        .uid("893361dc-9749-4997-93cb-802e3d7fa4xx")
    )
);

C# Elasticsearch .NET Client

var response = await client.LicenseManagement
    .PostAsync(d1 => d1
        .Licenses(d2 => d2
            .ExpiryDateInMillis(DateTimeOffset.Parse("2030-08-29T23:59:59.9990000+00:00", CultureInfo.InvariantCulture, DateTimeStyles.RoundtripKind))
            .IssueDateInMillis(DateTimeOffset.Parse("2014-09-29T00:00:00.0000000+00:00", CultureInfo.InvariantCulture, DateTimeStyles.RoundtripKind))
            .IssuedTo("issuedTo")
            .Issuer("issuer")
            .MaxNodes(1L)
            .Signature("xx")
            .Type(LicenseType.Basic)
            .Uid("893361dc-9749-4997-93cb-802e3d7fa4xx")
        )
    );

PHP Elasticsearch PHP Client

$resp = $client->license()->post([
    "body" => [
        "licenses" => array(
            [
                "uid" => "893361dc-9749-4997-93cb-802e3d7fa4xx",
                "type" => "basic",
                "issue_date_in_millis" => 1411948800000,
                "expiry_date_in_millis" => 1914278399999,
                "max_nodes" => 1,
                "issued_to" => "issuedTo",
                "issuer" => "issuer",
                "signature" => "xx",
            ],
        ),
    ],
]);

Ruby Elasticsearch Ruby Client

response = client.license.post(
  body: {
    "licenses": [
      {
        "uid": "893361dc-9749-4997-93cb-802e3d7fa4xx",
        "type": "basic",
        "issue_date_in_millis": 1411948800000,
        "expiry_date_in_millis": 1914278399999,
        "max_nodes": 1,
        "issued_to": "issuedTo",
        "issuer": "issuer",
        "signature": "xx"
      }
    ]
  }
)

Response

If you update to a basic license and you previously had a license with more features, you receive this type of response. You must re-submit the API request and set the acknowledge parameter to true.

{
  "acknowledged": false,
  "license_status": "valid",
  "acknowledge": {
    "message": "\"\"\"This license update requires acknowledgement. To acknowledge the license, please read the following messages and update the license again, this time with the \"acknowledge=true\" parameter:\"\"\"",
    "watcher": [
      "Watcher will be disabled"
    ],
    "logstash": [
      "Logstash will no longer poll for centrally-managed pipelines"
    ],
    "security": [
      "The following X-Pack security functionality will be disabled ..."
    ]
  }
}