luxolus
/
open-vault
2
0
Fork 0
Code Issues 1 Pull Requests Releases Activity

Update lease revocation api docs (#12453) 

* Update lease revocation api docs

* Update lease_id description for lease renew endpoint
This commit is contained in:
Pratyoy Mukhopadhyay 2021-08-27 14:44:16 -07:00 committed by GitHub
parent d2ac51815f
commit 8314a6a5f7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
website/content/api-docs/system/leases.mdx
View File

@ -91,8 +91,10 @@ cannot be renewed using this endpoint, use instead the auth/token/renew endpoint
### 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.
- `lease_id` `(string: <required>)` – Specifies the ID of the lease to extend. This
parameter can either be specified in a json request, as shown below, or provided as
a path parameter to the endpoint, like /sys/leases/revoke/:lease_id. If both are
provided, the leaseID in the request json takes precedence.
- `increment` `(int: 0)` – Specifies the requested amount of time (in seconds)
to extend the lease.
@ -136,7 +138,10 @@ This endpoint revokes a lease immediately.
### Parameters
- `lease_id` `(string: <required>)` – Specifies the ID of the lease to revoke.
- `lease_id` `(string: <required>)` – Specifies the ID of the lease to revoke. This
parameter can either be specified in a json request, as shown below, or provided as
a path parameter to the endpoint, like /sys/leases/revoke/:lease_id. If both are
provided, the leaseID in the request json takes precedence.
- `sync` `(bool: false)` - Instead of the default behaviour of queueing the lease
revocation, sync=true will revoke the lease immediately and only return once
complete.