open-vault/website/content/api-docs/system/license.mdx

101 lines
2.8 KiB
Plaintext
Raw Normal View History

2017-11-14 21:15:09 +00:00
---
layout: api
page_title: /sys/license/status - HTTP API
2017-11-14 21:15:09 +00:00
description: |-
The `/sys/license/status` endpoint is used to view the license used in
2017-11-14 21:15:09 +00:00
Vault.
---
# `/sys/license/status`
2017-11-14 21:15:09 +00:00
2021-06-18 16:19:18 +00:00
~> **Enterprise Only** These endpoints require Vault Enterprise.
2017-11-14 21:15:09 +00:00
The `/sys/license/status` endpoint is used to view update the license used in
2017-11-14 21:15:09 +00:00
Vault.
2021-06-18 16:19:18 +00:00
## License Status
This endpoint returns information about licensing. See [license autoloading](/docs/enterprise/license/autoloading) for additional background.
2021-06-18 16:19:18 +00:00
In the response:
- `autoloading_used` will be true if an autoloaded license was provided to the
node, false otherwise. This should always be true from Vault 1.11.0 onward.
- `autoloaded` is the autoloaded license if autoloading_used is true.
- `persisted_autoload` is the autoloaded license the active node last wrote to
2021-06-18 16:19:18 +00:00
storage; this is only used to detect inconsistently licensed nodes in the
cluster. It cannot be used as a license itself.
- `stored` was used for the stored license prior to Vault 1.11.0. Stored licenses are no longer supported.
2021-06-18 16:19:18 +00:00
`autoloaded`, and `persisted_autoload` will both have the same structure.
2021-06-18 16:19:18 +00:00
| Method | Path |
| :----- | :-------------------- |
2021-06-18 16:19:18 +00:00
| `GET` | `/sys/license/status` |
### Sample Request
```shell-session
$ curl \
--header "X-Vault-Token: ..." \
http://127.0.0.1:8200/v1/sys/license/status
```
### Sample Response
```json
{
"data": {
"autoloading_used": true,
"autoloaded": {
"expiration_time": "2022-05-17T23:59:59Z",
2021-06-18 16:19:18 +00:00
"features": [
"HSM",
"Performance Replication",
"DR Replication",
"MFA",
"Sentinel",
"Seal Wrapping",
"Control Groups",
"Performance Standby",
"Namespaces",
"KMIP",
"Entropy Augmentation",
"Transform Secrets Engine",
"Lease Count Quotas",
"Key Management Secrets Engine",
"Automated Snapshots"
],
"license_id": "060d7820-fa59-f95c-832b-395db0aeb9ba",
"performance_standby_count": 9999,
"start_time": "2021-05-17T00:00:00Z",
"termination_time": "2031-05-17T23:59:59Z"
2021-06-18 16:19:18 +00:00
},
"persisted_autoload": {
"expiration_time": "2022-05-17T23:59:59Z",
2021-06-18 16:19:18 +00:00
"features": [
"HSM",
"Performance Replication",
"DR Replication",
"MFA",
"Sentinel",
"Seal Wrapping",
"Control Groups",
"Performance Standby",
"Namespaces",
"KMIP",
"Entropy Augmentation",
"Transform Secrets Engine",
"Lease Count Quotas",
"Key Management Secrets Engine",
"Automated Snapshots"
],
"license_id": "060d7820-fa59-f95c-832b-395db0aeb9ba",
"performance_standby_count": 9999,
"start_time": "2021-05-17T00:00:00Z",
"termination_time": "2031-05-17T23:59:59Z"
2021-06-18 16:19:18 +00:00
}
}
2021-06-18 16:19:18 +00:00
}
```