aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorAlex Auvolat <alex@adnab.me>2022-05-11 11:51:11 +0200
committerAlex Auvolat <alex@adnab.me>2022-05-11 11:51:11 +0200
commitaeb978552a10eb89d183cdec04d242369127d764 (patch)
treeb8581315c1a0b4a3cb10040381789083310a86cd /doc
parent393b76ecba66ff11b80bf404691704568f2d1794 (diff)
downloadgarage-aeb978552a10eb89d183cdec04d242369127d764.tar.gz
garage-aeb978552a10eb89d183cdec04d242369127d764.zip
Short doc on UpdateKey
Diffstat (limited to 'doc')
-rw-r--r--doc/drafts/admin-api.md12
1 files changed, 11 insertions, 1 deletions
diff --git a/doc/drafts/admin-api.md b/doc/drafts/admin-api.md
index dc89014a..840dd4f7 100644
--- a/doc/drafts/admin-api.md
+++ b/doc/drafts/admin-api.md
@@ -326,6 +326,16 @@ Updates information about the specified API access key.
Request body format:
```json
-#TODO
+{
+ "name": "NameOfMyKey",
+ "allow": {
+ "createBucket": true,
+ },
+ "deny": {}
+}
```
+All fields (`name`, `allow` and `deny`) are optionnal.
+If they are present, the corresponding modifications are applied to the key, otherwise nothing is changed.
+The possible flags in `allow` and `deny` are: `createBucket`.
+