From 444f2b5469e9d2b9bf8d0d4f4cebb747ff9160a0 Mon Sep 17 00:00:00 2001 From: Alexander Bezobchuk Date: Fri, 11 Sep 2020 05:54:21 -0700 Subject: [PATCH] Merge PR #9922: Document rate limit list API --- .../api-docs/system/rate-limit-quotas.mdx | 37 +++++++++++++++++++ 1 file changed, 37 insertions(+) diff --git a/website/pages/api-docs/system/rate-limit-quotas.mdx b/website/pages/api-docs/system/rate-limit-quotas.mdx index 06db6b864..d739629e0 100644 --- a/website/pages/api-docs/system/rate-limit-quotas.mdx +++ b/website/pages/api-docs/system/rate-limit-quotas.mdx @@ -110,3 +110,40 @@ $ curl \ "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 +} +```