This commit updates the API documentation for the system backend to
break things apart on a per-page basis and provide specific examples.
This pattern will give more flexibility for future documentation as
well.

2017-03-16 09:46:49 -07:00

1.5 KiB

Raw Blame History

layout	page_title	sidebar_current	description
http	/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/(: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

{
  "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

{
  "lease_id": "aws/creds/deploy/e31b1145-ff27-e62c-cba2-934e9f0d1dbc",
  "renewable": true,
  "lease_duration": 2764790
}

1.5 KiB Raw Blame History Unescape Escape

/sys/renew