2017-11-14 21:15:09 +00:00
|
|
|
|
---
|
|
|
|
|
|
layout: "api"
|
|
|
|
|
|
page_title: "/sys/license - HTTP API"
|
2018-10-29 19:58:37 +00:00
|
|
|
|
sidebar_title: "<code>/sys/license</code>"
|
New Docs Website (#5535)
* conversion stage 1
* correct image paths
* add sidebar title to frontmatter
* docs/concepts and docs/internals
* configuration docs and multi-level nav corrections
* commands docs, index file corrections, small item nav correction
* secrets converted
* auth
* add enterprise and agent docs
* add extra dividers
* secret section, wip
* correct sidebar nav title in front matter for apu section, start working on api items
* auth and backend, a couple directory structure fixes
* remove old docs
* intro side nav converted
* reset sidebar styles, add hashi-global-styles
* basic styling for nav sidebar
* folder collapse functionality
* patch up border length on last list item
* wip restructure for content component
* taking middleman hacking to the extreme, but its working
* small css fix
* add new mega nav
* fix a small mistake from the rebase
* fix a content resolution issue with middleman
* title a couple missing docs pages
* update deps, remove temporary markup
* community page
* footer to layout, community page css adjustments
* wip downloads page
* deps updated, downloads page ready
* fix community page
* homepage progress
* add components, adjust spacing
* docs and api landing pages
* a bunch of fixes, add docs and api landing pages
* update deps, add deploy scripts
* add readme note
* update deploy command
* overview page, index title
* Update doc fields
Note this still requires the link fields to be populated -- this is solely related to copy on the description fields
* Update api_basic_categories.yml
Updated API category descriptions. Like the document descriptions you'll still need to update the link headers to the proper target pages.
* Add bottom hero, adjust CSS, responsive friendly
* Add mega nav title
* homepage adjustments, asset boosts
* small fixes
* docs page styling fixes
* meganav title
* some category link corrections
* Update API categories page
updated to reflect the second level headings for api categories
* Update docs_detailed_categories.yml
Updated to represent the existing docs structure
* Update docs_detailed_categories.yml
* docs page data fix, extra operator page remove
* api data fix
* fix makefile
* update deps, add product subnav to docs and api landing pages
* Rearrange non-hands-on guides to _docs_
Since there is no place for these on learn.hashicorp, we'll put them
under _docs_.
* WIP Redirects for guides to docs
* content and component updates
* font weight hotfix, redirects
* fix guides and intro sidenavs
* fix some redirects
* small style tweaks
* Redirects to learn and internally to docs
* Remove redirect to `/vault`
* Remove `.html` from destination on redirects
* fix incorrect index redirect
* final touchups
* address feedback from michell for makefile and product downloads
2018-10-19 15:40:11 +00:00
|
|
|
|
sidebar_current: "api-http-system-license"
|
2017-11-14 21:15:09 +00:00
|
|
|
|
description: |-
|
|
|
|
|
|
The `/sys/license` endpoint is used to view and update the license used in
|
|
|
|
|
|
Vault.
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
|
|
# `/sys/license`
|
|
|
|
|
|
|
|
|
|
|
|
~> **Enterprise Only** – These endpoints require Vault Enterprise.
|
|
|
|
|
|
|
|
|
|
|
|
The `/sys/license` endpoint is used to view and update the license used in
|
|
|
|
|
|
Vault.
|
|
|
|
|
|
|
|
|
|
|
|
## Read License
|
|
|
|
|
|
|
|
|
|
|
|
This endpoint returns information about the currently installed license.
|
|
|
|
|
|
|
2019-03-22 16:15:37 +00:00
|
|
|
|
| Method | Path |
|
|
|
|
|
|
| :--------------------------- | :--------------------- |
|
|
|
|
|
|
| `GET` | `/sys/license` |
|
2017-11-14 21:15:09 +00:00
|
|
|
|
|
|
|
|
|
|
### Sample Request
|
|
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
|
$ curl \
|
|
|
|
|
|
--header "X-Vault-Token: ..." \
|
2018-03-23 15:41:51 +00:00
|
|
|
|
http://127.0.0.1:8200/v1/sys/license
|
2017-11-14 21:15:09 +00:00
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
### Sample Response
|
|
|
|
|
|
|
|
|
|
|
|
```json
|
|
|
|
|
|
{
|
|
|
|
|
|
"data": {
|
|
|
|
|
|
"expiration_time": "2017-11-14T16:34:36.546753-05:00",
|
|
|
|
|
|
"features": [
|
|
|
|
|
|
"UI",
|
|
|
|
|
|
"HSM",
|
|
|
|
|
|
"Performance Replication",
|
|
|
|
|
|
"DR Replication"
|
|
|
|
|
|
],
|
|
|
|
|
|
"license_id": "temporary",
|
|
|
|
|
|
"start_time": "2017-11-14T16:04:36.546753-05:00"
|
|
|
|
|
|
},
|
|
|
|
|
|
"warnings": [
|
|
|
|
|
|
"time left on license is 29m33s"
|
|
|
|
|
|
]
|
|
|
|
|
|
}
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
## Install License
|
|
|
|
|
|
|
|
|
|
|
|
This endpoint is used to install a license into Vault.
|
|
|
|
|
|
|
2019-03-22 16:15:37 +00:00
|
|
|
|
| Method | Path |
|
|
|
|
|
|
| :--------------------------- | :--------------------- |
|
|
|
|
|
|
| `PUT` | `/sys/license` |
|
2017-11-14 21:15:09 +00:00
|
|
|
|
|
2018-01-23 02:44:38 +00:00
|
|
|
|
### Parameters
|
|
|
|
|
|
|
|
|
|
|
|
- `text` `(string: <required>)` – The text of the license.
|
|
|
|
|
|
|
|
|
|
|
|
*DR Secondary Specific Parameters*
|
|
|
|
|
|
|
|
|
|
|
|
- `dr_operation_token` `(string: <required>)` - DR operation token used to authorize this request.
|
|
|
|
|
|
|
|
|
|
|
|
|
2017-11-14 21:15:09 +00:00
|
|
|
|
### Sample Payload
|
|
|
|
|
|
|
|
|
|
|
|
```json
|
|
|
|
|
|
{
|
|
|
|
|
|
"text": "01ABCDEFG..."
|
|
|
|
|
|
}
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
### Sample Request
|
|
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
|
$ curl \
|
|
|
|
|
|
--header "X-Vault-Token: ..." \
|
|
|
|
|
|
--request PUT \
|
|
|
|
|
|
--data @payload.json \
|
2018-03-23 15:41:51 +00:00
|
|
|
|
http://127.0.0.1:8200/v1/sys/license
|
2017-11-14 21:15:09 +00:00
|
|
|
|
```
|