mirror of
https://github.com/hashicorp/vault.git
synced 2025-08-22 15:11:07 +02:00
0660ea6fac
* Update README Let contributors know that docs will now be located in UDR * Add comments to each mdx doc Comment has been added to all mdx docs that are not partials * chore: added changelog changelog check failure * wip: removed changelog * Fix content errors * Doc spacing * Update website/content/docs/deploy/kubernetes/vso/helm.mdx Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com> --------- Co-authored-by: jonathanfrappier <92055993+jonathanfrappier@users.noreply.github.com> Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com>
104 lines
3.2 KiB
Plaintext
104 lines
3.2 KiB
Plaintext
---
|
|
layout: api
|
|
page_title: /sys/license/status - HTTP API
|
|
description: |-
|
|
The `/sys/license/status` endpoint is used to view the license used in
|
|
Vault.
|
|
---
|
|
|
|
> [!IMPORTANT]
|
|
> **Documentation Update:** Product documentation, which were located in this repository under `/website`, are now located in [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs), colocated with all other product documentation. Contributions to this content should be done in the `web-unified-docs` repo, and not this one. Changes made to `/website` content in this repo will not be reflected on the developer.hashicorp.com website.
|
|
|
|
# `/sys/license/status`
|
|
|
|
@include 'alerts/enterprise-only.mdx'
|
|
|
|
The `/sys/license/status` endpoint is used to view update the license used in
|
|
Vault.
|
|
|
|
## License status
|
|
|
|
This endpoint returns information about licensing. See [license autoloading](/vault/docs/enterprise/license/autoloading) for additional background.
|
|
|
|
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
|
|
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.
|
|
|
|
`autoloaded`, and `persisted_autoload` will both have the same structure.
|
|
|
|
| Method | Path |
|
|
| :----- | :-------------------- |
|
|
| `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",
|
|
"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"
|
|
},
|
|
"persisted_autoload": {
|
|
"expiration_time": "2022-05-17T23:59:59Z",
|
|
"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"
|
|
}
|
|
}
|
|
}
|
|
```
|