2015-04-19 05:39:43 +00:00
|
|
|
---
|
|
|
|
layout: "http"
|
|
|
|
page_title: "HTTP API: /sys/renew"
|
|
|
|
sidebar_current: "docs-http-lease-renew"
|
|
|
|
description: |-
|
|
|
|
The `/sys/renew` endpoint is used to renew secrets.
|
|
|
|
---
|
|
|
|
|
|
|
|
# /sys/renew
|
|
|
|
|
|
|
|
<dl>
|
2015-04-22 23:47:11 +00:00
|
|
|
<dt>Description</dt>
|
|
|
|
<dd>
|
|
|
|
Renew a secret, requesting to extend the lease.
|
|
|
|
</dd>
|
2015-04-19 05:39:43 +00:00
|
|
|
|
2015-04-22 23:47:11 +00:00
|
|
|
<dt>Method</dt>
|
|
|
|
<dd>PUT</dd>
|
2015-04-19 05:39:43 +00:00
|
|
|
|
2015-04-22 23:47:11 +00:00
|
|
|
<dt>URL</dt>
|
2016-08-08 22:00:44 +00:00
|
|
|
<dd>`/sys/renew(/<lease id>)`</dd>
|
2015-04-19 05:39:43 +00:00
|
|
|
|
2015-04-22 23:47:11 +00:00
|
|
|
<dt>Parameters</dt>
|
|
|
|
<dd>
|
|
|
|
<ul>
|
|
|
|
<li>
|
|
|
|
<span class="param">increment</span>
|
|
|
|
<span class="param-flags">optional</span>
|
|
|
|
A requested amount of time in seconds to extend the lease.
|
|
|
|
This is advisory.
|
|
|
|
</li>
|
2016-08-08 22:00:44 +00:00
|
|
|
<li>
|
|
|
|
<span class="param">lease_id</span>
|
|
|
|
<span class="param-flags">required</span>
|
|
|
|
The ID of the lease to extend. This can be specified as part of the URL
|
|
|
|
or in the request body.
|
|
|
|
</li>
|
2015-04-22 23:47:11 +00:00
|
|
|
</ul>
|
|
|
|
</dd>
|
2015-04-19 05:39:43 +00:00
|
|
|
|
2015-04-22 23:47:11 +00:00
|
|
|
<dt>Returns</dt>
|
|
|
|
<dd>A secret structure.
|
|
|
|
</dd>
|
2015-04-19 05:39:43 +00:00
|
|
|
</dl>
|