2017-09-08 02:07:28 +00:00
|
|
|
---
|
2020-01-18 00:18:09 +00:00
|
|
|
layout: docs
|
|
|
|
page_title: lease revoke - Command
|
2017-09-08 02:07:28 +00:00
|
|
|
description: |-
|
|
|
|
The "lease revoke" command revokes the lease on a secret, invalidating the
|
|
|
|
underlying secret.
|
|
|
|
---
|
|
|
|
|
|
|
|
# lease revoke
|
|
|
|
|
|
|
|
The `lease revoke` command revokes the lease on a secret, invalidating the
|
|
|
|
underlying secret.
|
|
|
|
|
|
|
|
## Examples
|
|
|
|
|
|
|
|
Revoke a lease:
|
|
|
|
|
2020-05-21 17:18:17 +00:00
|
|
|
```shell-session
|
2017-09-08 02:07:28 +00:00
|
|
|
$ vault lease revoke database/creds/readonly/27e1b9a1-27b8-83d9-9fe0-d99d786bdc83
|
|
|
|
Success! Revoked lease: database/creds/readonly/27e1b9a1-27b8-83d9-9fe0-d99d786bdc83
|
|
|
|
```
|
|
|
|
|
|
|
|
Revoke a lease which starts with a prefix:
|
|
|
|
|
2020-05-21 17:18:17 +00:00
|
|
|
```shell-session
|
2017-09-08 02:07:28 +00:00
|
|
|
$ vault lease revoke -prefix database/creds
|
|
|
|
Success! Revoked any leases with prefix: database/creds
|
|
|
|
```
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
|
|
|
|
The following flags are available in addition to the [standard set of
|
2020-01-22 20:05:41 +00:00
|
|
|
flags](/docs/commands) included on all commands.
|
2017-09-08 02:07:28 +00:00
|
|
|
|
|
|
|
- `-force` `(bool: false)` - Delete the lease from Vault even if the secret
|
|
|
|
engine revocation fails. This is meant for recovery situations where the
|
2017-09-20 20:05:00 +00:00
|
|
|
secret in the target secrets engine was manually removed. If this flag is
|
2017-09-08 02:07:28 +00:00
|
|
|
specified, -prefix is also required. This is aliased as "-f". The default is
|
|
|
|
false.
|
|
|
|
|
|
|
|
- `-prefix` `(bool: false)` - Treat the ID as a prefix instead of an exact lease
|
|
|
|
ID. This can revoke multiple leases simultaneously. The default is false.
|
2021-05-06 14:18:46 +00:00
|
|
|
|
|
|
|
- `-sync` `(bool: false)` - Make the operation synchronous instead of queuing the
|
|
|
|
revocations to be done in the background.
|