2017-05-04 02:03:42 +00:00
|
|
|
|
---
|
|
|
|
|
layout: "api"
|
|
|
|
|
page_title: "/sys/leases - HTTP API"
|
2018-10-29 19:58:37 +00:00
|
|
|
|
sidebar_title: "<code>/sys/leases</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-leases"
|
2017-05-04 02:03:42 +00:00
|
|
|
|
description: |-
|
|
|
|
|
The `/sys/leases` endpoints are used to view and manage leases.
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
# `/sys/leases`
|
|
|
|
|
|
|
|
|
|
The `/sys/leases` endpoints are used to view and manage leases in Vault.
|
|
|
|
|
|
|
|
|
|
## Read Lease
|
|
|
|
|
|
|
|
|
|
This endpoint retrieve lease metadata.
|
|
|
|
|
|
2019-03-22 16:15:37 +00:00
|
|
|
|
| Method | Path |
|
|
|
|
|
| :---------------------------- | :--------------------- |
|
|
|
|
|
| `PUT` | `/sys/leases/lookup` |
|
2017-05-04 02:03:42 +00:00
|
|
|
|
|
|
|
|
|
### Parameters
|
|
|
|
|
|
|
|
|
|
- `lease_id` `(string: <required>)` – Specifies the ID of the lease to lookup.
|
|
|
|
|
|
|
|
|
|
### Sample Payload
|
|
|
|
|
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"lease_id": "aws/creds/deploy/abcd-1234..."
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### 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/leases/lookup
|
2017-05-04 02:03:42 +00:00
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Sample Response
|
|
|
|
|
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"id": "auth/token/create/25c75065466dfc5f920525feafe47502c4c9915c",
|
|
|
|
|
"issue_time": "2017-04-30T10:18:11.228946471-04:00",
|
|
|
|
|
"expire_time": "2017-04-30T11:18:11.228946708-04:00",
|
|
|
|
|
"last_renewal_time": null,
|
|
|
|
|
"renewable": true,
|
|
|
|
|
"ttl": 3558
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## List Leases
|
|
|
|
|
|
|
|
|
|
This endpoint returns a list of lease ids.
|
|
|
|
|
|
|
|
|
|
**This endpoint requires 'sudo' capability.**
|
|
|
|
|
|
2019-03-22 16:15:37 +00:00
|
|
|
|
| Method | Path |
|
|
|
|
|
| :--------------------------- | :--------------------- |
|
|
|
|
|
| `LIST` | `/sys/leases/lookup/:prefix` |
|
2017-05-04 02:03:42 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### Sample Request
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
$ curl \
|
|
|
|
|
--header "X-Vault-Token: ..." \
|
|
|
|
|
--request LIST \
|
2018-03-23 15:41:51 +00:00
|
|
|
|
http://127.0.0.1:8200/v1/sys/leases/lookup/aws/creds/deploy/
|
2017-05-04 02:03:42 +00:00
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Sample Response
|
|
|
|
|
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"data":{
|
|
|
|
|
"keys":[
|
|
|
|
|
"abcd-1234...",
|
|
|
|
|
"efgh-1234...",
|
|
|
|
|
"ijkl-1234..."
|
|
|
|
|
]
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Renew Lease
|
|
|
|
|
|
|
|
|
|
This endpoint renews a lease, requesting to extend the lease.
|
|
|
|
|
|
2019-03-22 16:15:37 +00:00
|
|
|
|
| Method | Path |
|
|
|
|
|
| :---------------------------- | :--------------------- |
|
|
|
|
|
| `PUT` | `/sys/leases/renew` |
|
2017-05-04 02:03:42 +00:00
|
|
|
|
|
|
|
|
|
### Parameters
|
|
|
|
|
|
|
|
|
|
- `lease_id` `(string: <required>)` – Specifies the ID of the lease to extend.
|
|
|
|
|
This can be specified as part of the URL or as part of the request body.
|
|
|
|
|
|
|
|
|
|
- `increment` `(int: 0)` – Specifies the requested amount of time (in seconds)
|
|
|
|
|
to extend the lease.
|
|
|
|
|
|
|
|
|
|
### Sample Payload
|
|
|
|
|
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"lease_id": "aws/creds/deploy/abcd-1234...",
|
|
|
|
|
"increment": 1800
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### 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/leases/renew
|
2017-05-04 02:03:42 +00:00
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Sample Response
|
|
|
|
|
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"lease_id": "aws/creds/deploy/abcd-1234...",
|
|
|
|
|
"renewable": true,
|
|
|
|
|
"lease_duration": 2764790
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Revoke Lease
|
|
|
|
|
|
|
|
|
|
This endpoint revokes a lease immediately.
|
|
|
|
|
|
2019-03-22 16:15:37 +00:00
|
|
|
|
| Method | Path |
|
|
|
|
|
| :---------------------------- | :--------------------- |
|
|
|
|
|
| `PUT` | `/sys/leases/revoke` |
|
2017-05-04 02:03:42 +00:00
|
|
|
|
|
|
|
|
|
### Parameters
|
|
|
|
|
|
|
|
|
|
- `lease_id` `(string: <required>)` – Specifies the ID of the lease to revoke.
|
|
|
|
|
|
|
|
|
|
### Sample Payload
|
|
|
|
|
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"lease_id": "postgresql/creds/readonly/abcd-1234..."
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### 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/leases/revoke
|
2017-05-04 02:03:42 +00:00
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Revoke Force
|
|
|
|
|
|
|
|
|
|
This endpoint revokes all secrets or tokens generated under a given prefix
|
|
|
|
|
immediately. Unlike `/sys/leases/revoke-prefix`, this path ignores backend errors
|
|
|
|
|
encountered during revocation. This is _potentially very dangerous_ and should
|
|
|
|
|
only be used in specific emergency situations where errors in the backend or the
|
|
|
|
|
connected backend service prevent normal revocation.
|
|
|
|
|
|
|
|
|
|
By ignoring these errors, Vault abdicates responsibility for ensuring that the
|
|
|
|
|
issued credentials or secrets are properly revoked and/or cleaned up. Access to
|
|
|
|
|
this endpoint should be tightly controlled.
|
|
|
|
|
|
|
|
|
|
**This endpoint requires 'sudo' capability.**
|
|
|
|
|
|
2019-03-22 16:15:37 +00:00
|
|
|
|
| Method | Path |
|
|
|
|
|
| :---------------------------------- | :--------------------- |
|
|
|
|
|
| `PUT` | `/sys/leases/revoke-force/:prefix` |
|
2017-05-04 02:03:42 +00:00
|
|
|
|
|
|
|
|
|
### Parameters
|
|
|
|
|
|
|
|
|
|
- `prefix` `(string: <required>)` – Specifies the prefix to revoke. This is
|
|
|
|
|
specified as part of the URL.
|
|
|
|
|
|
|
|
|
|
### Sample Request
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
$ curl \
|
|
|
|
|
--header "X-Vault-Token: ..." \
|
|
|
|
|
--request PUT \
|
2018-03-23 15:41:51 +00:00
|
|
|
|
http://127.0.0.1:8200/v1/sys/leases/revoke-force/aws/creds
|
2017-05-04 02:03:42 +00:00
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Revoke Prefix
|
|
|
|
|
|
|
|
|
|
This endpoint revokes all secrets (via a lease ID prefix) or tokens (via the
|
|
|
|
|
tokens' path property) generated under a given prefix immediately. This requires
|
|
|
|
|
`sudo` capability and access to it should be tightly controlled as it can be
|
|
|
|
|
used to revoke very large numbers of secrets/tokens at once.
|
|
|
|
|
|
|
|
|
|
**This endpoint requires 'sudo' capability.**
|
|
|
|
|
|
2019-03-22 16:15:37 +00:00
|
|
|
|
| Method | Path |
|
|
|
|
|
| :---------------------------------- | :--------------------- |
|
|
|
|
|
| `PUT` | `/sys/leases/revoke-prefix/:prefix` |
|
2017-05-04 02:03:42 +00:00
|
|
|
|
|
|
|
|
|
### Parameters
|
|
|
|
|
|
|
|
|
|
- `prefix` `(string: <required>)` – Specifies the prefix to revoke. This is
|
|
|
|
|
specified as part of the URL.
|
|
|
|
|
|
|
|
|
|
### Sample Request
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
$ curl \
|
|
|
|
|
--header "X-Vault-Token: ..." \
|
|
|
|
|
--request PUT \
|
2018-03-23 15:41:51 +00:00
|
|
|
|
http://127.0.0.1:8200/v1/sys/leases/revoke-prefix/aws/creds
|
2017-05-04 02:03:42 +00:00
|
|
|
|
```
|