Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: remove API doc for license PUT #10483

Merged
merged 1 commit into from
Apr 30, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 3 additions & 47 deletions website/content/api-docs/operator/license.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: api
page_title: License - Operator - HTTP API
description: |-
The /operator/license endpoints allow for setting and retrieving the Nomad Enterprise License.
The /operator/license endpoints allow for retrieving the Nomad Enterprise License.
---

# License Operator HTTP API
Expand Down Expand Up @@ -40,7 +40,7 @@ $ curl \
"LastContact": 0,
"LastIndex": 0,
"License": {
"CustomerID": "temporary license customer",
"CustomerID": "customer name",
"ExpirationTime": "2020-06-01T14:50:16.581304556-04:00",
"Features": [
"Automated Upgrades",
Expand All @@ -57,7 +57,7 @@ $ curl \
},
"InstallationID": "*",
"IssueTime": "2020-06-01T08:50:16.581304556-04:00",
"LicenseID": "temporary-license",
"LicenseID": "6f706a45-bdac-4a70-968b-d93784894653",
"Modules": ["governance-policy"],
"Product": "nomad",
"StartTime": "2020-06-01T08:50:16.581304556-04:00",
Expand All @@ -66,47 +66,3 @@ $ curl \
"RequestTime": 0
}
```

## Updating the Nomad Enterprise License

This endpoint updates the Nomad license.

| Method | Path | Produces |
| ------ | ---------------------- | ------------------ |
| `PUT` | `/v1/operator/license` | `application/json` |

The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries) and
[required ACLs](/api-docs#acls).

| Blocking Queries | ACL Required |
| ---------------- | ---------------- |
| `NO` | `operator:write` |

### Parameters

- `force` `(bool: false)` Force the license to be applied. By default, Nomad
will only accept a new license if it is newer than the one currently applied
(specified by the license issue date). Use `force` to override and apply an
older, unexpired license.

### Sample Payload

The payload is the raw license blob.

### Sample Request

```shell-session
$ curl \
--request PUT \
--data @nomad.license \
https://localhost:4646/v1/operator/license?force=true
```

### Sample Response

```json
{
"Index": 15
}
```