»License Operator HTTP API

Enterprise

This feature requires Nomad Enterprise.

»Get Nomad Enterprise License Info

This endpoint gets information about the current license.

MethodPathProduces
GET/v1/operator/licenseapplication/json

The table below shows this endpoint's support for blocking queries and required ACLs.

Blocking QueriesACL Required
NOoperator:read

»Sample Request

$ curl \
    https://localhost:4646/v1/operator/license

»Sample Response

{
  "KnownLeader": false,
  "LastContact": 0,
  "LastIndex": 0,
  "License": {
    "CustomerID": "temporary license customer",
    "ExpirationTime": "2020-06-01T14:50:16.581304556-04:00",
    "Features": [
      "Automated Upgrades",
      "Enhanced Read Scalability",
      "Redundancy Zones",
      "Namespaces",
      "Resource Quotas",
      "Preemption",
      "Audit Logging",
      "Setinel Policies"
    ],
    "Flags": {
      "modules": ["governance-policy"]
    },
    "InstallationID": "*",
    "IssueTime": "2020-06-01T08:50:16.581304556-04:00",
    "LicenseID": "temporary-license",
    "Modules": ["governance-policy"],
    "Product": "nomad",
    "StartTime": "2020-06-01T08:50:16.581304556-04:00",
    "TerminationTime": "2020-06-01T14:50:16.581304556-04:00"
  },
  "RequestTime": 0
}

»Updating the Nomad Enterprise License

This endpoint updates the Nomad license.

MethodPathProduces
PUT/v1/operator/licenseapplication/json

The table below shows this endpoint's support for blocking queries and required ACLs.

Blocking QueriesACL Required
NOoperator:write

»Sample Payload

The payload is the raw license blob.

»Sample Request

$ curl \
    --request PUT \
    --data @nomad.license \
    https://localhost:4646/v1/operator/license

»Sample Response

{
  "Index": 15
}