aboutsummaryrefslogtreecommitdiff
path: root/doc/drafts/admin-api.md
diff options
context:
space:
mode:
authorAlex Auvolat <alex@adnab.me>2022-05-11 10:27:40 +0200
committerAlex Auvolat <alex@adnab.me>2022-05-11 10:27:40 +0200
commitf97a7845e9e9ab68c3b8afc0d1091765ed11439c (patch)
treea3be49b225bf902e3ed4c8cacb849faa84aa106c /doc/drafts/admin-api.md
parentbb6ec9ebd979c168091c7b00cc8b97da4a1a8dc9 (diff)
downloadgarage-f97a7845e9e9ab68c3b8afc0d1091765ed11439c.tar.gz
garage-f97a7845e9e9ab68c3b8afc0d1091765ed11439c.zip
Add API access key admin endpoints
Diffstat (limited to 'doc/drafts/admin-api.md')
-rw-r--r--doc/drafts/admin-api.md49
1 files changed, 49 insertions, 0 deletions
diff --git a/doc/drafts/admin-api.md b/doc/drafts/admin-api.md
index ab24e18f..baf87e61 100644
--- a/doc/drafts/admin-api.md
+++ b/doc/drafts/admin-api.md
@@ -209,3 +209,52 @@ Similarly to the CLI, the body must include the incremented
version number, which MUST be 1 + the value of the currently
existing layout in the cluster.
+
+## Access key operations
+
+### ListKeys `GET /key`
+
+Returns all API access keys in the cluster.
+
+Example response:
+
+```json
+#TODO
+```
+
+### CreateKey `POST /key`
+
+Creates a new API access key.
+
+Request body format:
+
+```json
+{
+ "name": "NameOfMyKey"
+}
+```
+
+### GetKeyInfo `GET /key?id=<acces key id>`
+
+Returns information about the requested API access key.
+
+Example response:
+
+```json
+#TODO
+```
+
+### DeleteKey `DELETE /key?id=<acces key id>`
+
+Deletes an API access key.
+
+### UpdateKey `POST /key?id=<acces key id>`
+
+Updates information about the specified API access key.
+
+Request body format:
+
+```json
+#TODO
+```
+