diff --git a/website/source/api/operator/license.html.md b/website/source/api/operator/license.html.md index 1110ec9b10..5a52c220f8 100644 --- a/website/source/api/operator/license.html.md +++ b/website/source/api/operator/license.html.md @@ -143,3 +143,65 @@ $ curl \ "Warnings": [] } ``` + +## Resetting the Consul License + +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](/api/features/blocking.html), +[consistency modes](/api/features/consistency.html), +[agent caching](/api/features/caching.html), and +[required ACLs](/api/index.html#authentication). + +| Blocking Queries | Consistency Modes | Agent Caching | ACL Required | +| ---------------- | ----------------- | ------------- | ---------------- | +| `NO` | `none` | `none` | `operator:write` | + +### Parameters + +- `dc` `(string: "")` - Specifies the datacenter whose license should be updated. + This will default to the datacenter of the agent serving the HTTP request. + This is specified as a URL query parameter. + +### Sample Request + +```text +$ curl \ + --request DELETE \ + http://127.0.0.1:8500/v1/operator/license +``` + +### Sample Response + +```json +{ + "Valid": true, + "License": { + "license_id": "2afbf681-0d1a-0649-cb6c-333ec9f0989c", + "customer_id": "0259271d-8ffc-e85e-0830-c0822c1f5f2b", + "installation_id": "*", + "issue_time": "2018-05-21T20:03:35.911567355Z", + "start_time": "2018-05-21T04:00:00Z", + "expiration_time": "2019-05-22T03:59:59.999Z", + "product": "consul", + "flags": { + "package": "premium" + }, + "features": [ + "Automated Backups", + "Automated Upgrades", + "Enhanced Read Scalability", + "Network Segments", + "Redundancy Zone", + "Advanced Network Federation" + ], + "temporary": false + }, + "Warnings": [] +} +```