Skip to content

Commit

Permalink
Document the sync option for revoke/revoke-prefix. (hashicorp#11538)
Browse files Browse the repository at this point in the history
  • Loading branch information
ncabatoff committed May 6, 2021
1 parent d60b698 commit e5f86dc
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 0 deletions.
6 changes: 6 additions & 0 deletions website/content/api-docs/system/leases.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,9 @@ This endpoint revokes a lease immediately.
### Parameters

- `lease_id` `(string: <required>)` – Specifies the ID of the lease to revoke.
- `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.

### Sample Payload

Expand Down Expand Up @@ -205,6 +208,9 @@ used to revoke very large numbers of secrets/tokens at once.

- `prefix` `(string: <required>)` – Specifies the prefix to revoke. This is
specified as part of the URL.
- `sync` `(bool: false)` - Instead of the default behaviour of queueing the lease
revocations, sync=true will revoke ths leases immediately and only return once
complete.

### Sample Request

Expand Down
3 changes: 3 additions & 0 deletions website/content/docs/commands/lease/revoke.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -40,3 +40,6 @@ flags](/docs/commands) included on all commands.

- `-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.

- `-sync` `(bool: false)` - Make the operation synchronous instead of queuing the
revocations to be done in the background.

0 comments on commit e5f86dc

Please sign in to comment.