open-nomad/website/content/api-docs/operator/license.mdx
2021-04-30 10:39:21 -04:00

69 lines
1.6 KiB
Plaintext

---
layout: api
page_title: License - Operator - HTTP API
description: |-
The /operator/license endpoints allow for retrieving the Nomad Enterprise License.
---
# License Operator HTTP API
<EnterpriseAlert />
## Get Nomad Enterprise License Info
This endpoint gets information about the current license.
| Method | Path | Produces |
| ------ | ---------------------- | ------------------ |
| `GET` | `/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:read` |
### Sample Request
```shell-session
$ curl \
https://localhost:4646/v1/operator/license
```
### Sample Response
```json
{
"KnownLeader": false,
"LastContact": 0,
"LastIndex": 0,
"License": {
"CustomerID": "customer name",
"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": "6f706a45-bdac-4a70-968b-d93784894653",
"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
}
```