2017-03-15 06:40:33 +00:00
|
|
|
|
---
|
2017-03-17 18:06:03 +00:00
|
|
|
|
layout: "api"
|
2017-03-15 06:40:33 +00:00
|
|
|
|
page_title: "/sys/renew - HTTP API"
|
|
|
|
|
|
sidebar_current: "docs-http-system-renew"
|
|
|
|
|
|
description: |-
|
|
|
|
|
|
The `/sys/renew` endpoint is used to renew secrets.
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
|
|
# `/sys/renew`
|
|
|
|
|
|
|
|
|
|
|
|
The `/sys/renew` endpoint is used to renew secrets.
|
|
|
|
|
|
|
|
|
|
|
|
## Renew Secret
|
|
|
|
|
|
|
|
|
|
|
|
This endpoint renews a secret, requesting to extend the lease.
|
|
|
|
|
|
|
|
|
|
|
|
| Method | Path | Produces |
|
|
|
|
|
|
| :------- | :--------------------------- | :--------------------- |
|
|
|
|
|
|
| `PUT` | `/sys/renew/(:lease_id)` | `200 application/json` |
|
|
|
|
|
|
|
|
|
|
|
|
### 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": "postgresql/creds/readonly/abcd-1234...",
|
|
|
|
|
|
"increment": 1800
|
|
|
|
|
|
}
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
### Sample Request
|
|
|
|
|
|
|
|
|
|
|
|
With the `lease_id` as part of the URL:
|
|
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
|
$ curl \
|
|
|
|
|
|
--header "X-Vault-Token: ..." \
|
|
|
|
|
|
--request PUT \
|
|
|
|
|
|
--data @payload.json \
|
|
|
|
|
|
https://vault.rocks/v1/sys/renew/postgresql/creds/readonly/abcd-1234
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
With the `lease_id` in the request body:
|
|
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
|
$ curl \
|
|
|
|
|
|
--header "X-Vault-Token: ..." \
|
|
|
|
|
|
--request PUT \
|
|
|
|
|
|
--data @payload.json \
|
|
|
|
|
|
https://vault.rocks/v1/sys/renew
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
### Sample Response
|
|
|
|
|
|
|
|
|
|
|
|
```json
|
|
|
|
|
|
{
|
|
|
|
|
|
"lease_id": "aws/creds/deploy/e31b1145-ff27-e62c-cba2-934e9f0d1dbc",
|
|
|
|
|
|
"renewable": true,
|
|
|
|
|
|
"lease_duration": 2764790
|
|
|
|
|
|
}
|
|
|
|
|
|
```
|
