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

Merge PR #9922: Document rate limit list API

This commit is contained in:
Alexander Bezobchuk 2020-09-11 05:54:21 -07:00 committed by GitHub
parent 4633f5a8fc
commit 444f2b5469
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 37 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
website/pages/api-docs/system/rate-limit-quotas.mdx
View File

@ -110,3 +110,40 @@ $ curl \
"warnings": null "warnings": null
} }
``` ```
## List Rate Limit Quotas
This endpoint returns a list of all the rate limit quotas.
| Method | Path |
| :----- | :----------------------- |
| `LIST` | `/sys/quotas/rate-limit` |
### Sample Request
```shell-session
$ curl \
--request LIST \
--header "X-Vault-Token: ..." \
http://127.0.0.1:8200/v1/sys/quotas/rate-limit
```
### Sample Response
```json
{
"auth": null,
"data": {
"keys": [
"global-rate-limiter",
"kv-rate-limiter"
]
},
"lease_duration": 0,
"lease_id": "",
"renewable": false,
"request_id": "ab633ee1-a692-ba03-083b-f1bd91c51c28",
"warnings": null,
"wrap_info": null
}
```