luxolus
/
open-vault
2
0
Fork 0
Code Issues 1 Pull Requests Releases Activity
open-vault/website/source/api/system/revoke.html.md

33 lines
776 B
Markdown
Raw Normal View History

Redo docs for system backend This commit updates the API documentation for the system backend to break things apart on a per-page basis and provide specific examples. This pattern will give more flexibility for future documentation as well.
2017-03-15 06:40:33 +00:00
---
/docs/http -> /api
2017-03-17 18:06:03 +00:00
layout: "api"
Redo docs for system backend This commit updates the API documentation for the system backend to break things apart on a per-page basis and provide specific examples. This pattern will give more flexibility for future documentation as well.
2017-03-15 06:40:33 +00:00
page_title: "/sys/revoke - HTTP API"
sidebar_current: "docs-http-system-revoke/"
description: |-
The `/sys/revoke` endpoint is used to revoke secrets.
---
# `/sys/revoke`
The `/sys/revoke` endpoint is used to revoke secrets.
## Revoke Secret
This endpoint revokes a secret immediately.
| Method | Path | Produces |
| :------- | :--------------------------- | :--------------------- |
| `PUT` | `/sys/revoke/:lease_id` | `204 (empty body)` |
### Parameters
Update revoke.html.md (#2604) Changed param's description verb from renew to revoke, to match the page context.
2017-04-17 16:40:24 +00:00
- `lease_id` `(string: <required>)` – Specifies the ID of the lease to revoke.
Redo docs for system backend This commit updates the API documentation for the system backend to break things apart on a per-page basis and provide specific examples. This pattern will give more flexibility for future documentation as well.
2017-03-15 06:40:33 +00:00
### Sample Request
```
$ curl \
--header "X-Vault-Token: ..." \
--request PUT \
https://vault.rocks/v1/sys/revoke/aws/creds/readonly-acbd1234
```