open-vault/website/source/api/system/renew.html.md
2017-04-27 10:47:43 -04:00

1.2 KiB
Raw Blame History

layout page_title sidebar_current description
api /sys/renew - HTTP API docs-http-system-renew 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 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

{
  "lease_id": "aws/creds/deploy/abcd-1234...",
  "increment": 1800
}

Sample Request

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

{
  "lease_id": "aws/creds/deploy/abcd-1234...",
  "renewable": true,
  "lease_duration": 2764790
}