open-vault/website/source/docs/http/sys-renew.html.md

45 lines
923 B
Markdown
Raw Normal View History

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>
<dt>Description</dt>
<dd>
Renew a secret, requesting to extend the lease.
</dd>
2015-04-19 05:39:43 +00:00
<dt>Method</dt>
<dd>PUT</dd>
2015-04-19 05:39:43 +00:00
<dt>URL</dt>
<dd>`/sys/renew(/<lease id>)`</dd>
2015-04-19 05:39:43 +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>
<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>
</ul>
</dd>
2015-04-19 05:39:43 +00:00
<dt>Returns</dt>
<dd>A secret structure.
</dd>
2015-04-19 05:39:43 +00:00
</dl>