License - Operator HTTP API
This feature requires Consul Enterprise(opens in new tab).
The licensing functionality described here is available only in Consul Enterprise version 1.1.0 and later.
Getting the Consul License
This endpoint gets information about the current license.
Method | Path | Produces |
---|---|---|
GET | /operator/license | application/json |
The table below shows this endpoint's support for blocking queries, consistency modes, agent caching, and required ACLs.
Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
---|---|---|---|
NO | all | none | none |
The corresponding CLI command is consul license get
.
Query Parameters
dc
(string: "")
- Specifies the datacenter whose license should be retrieved. This will default to the datacenter of the agent serving the HTTP request.
Sample Request
Sample Response
Updating the Consul License
Deprecated This endpoint was removed in Consul v1.10.0 along with the ability to manage the cluster's license via the API.
This endpoint updates the Consul license and returns some of the license contents as well as any warning messages regarding its validity.
Method | Path | Produces |
---|---|---|
PUT | /operator/license | application/json |
The table below shows this endpoint's support for blocking queries, consistency modes, agent caching, and required ACLs.
Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
---|---|---|---|
NO | none | none | operator:write |
The corresponding CLI command is consul license put
.
Query Parameters
dc
(string: "")
- Specifies the datacenter whose license should be updated. This will default to the datacenter of the agent serving the HTTP request.
Sample Payload
The payload is the raw license blob.
Sample Request
Sample Response
Resetting the Consul License
Deprecated This endpoint was removed in Consul v1.10.0 along with the ability to manage the cluster's license via the API.
This endpoint resets the Consul license to the license included in the Enterprise binary. If the included license is not valid, the replace will fail.
Method | Path | Produces |
---|---|---|
DELETE | /operator/license | application/json |
The table below shows this endpoint's support for blocking queries, consistency modes, agent caching, and required ACLs.
Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
---|---|---|---|
NO | none | none | operator:write |
The corresponding CLI command is consul license reset
.
Query Parameters
dc
(string: "")
- Specifies the datacenter whose license should be updated. This will default to the datacenter of the agent serving the HTTP request.
Sample Request
Sample Response