aboutsummaryrefslogtreecommitdiff
path: root/doc/drafts/admin-api.md
diff options
context:
space:
mode:
authorAlex Auvolat <alex@adnab.me>2022-05-17 17:16:29 +0200
committerAlex Auvolat <alex@adnab.me>2022-05-17 17:16:29 +0200
commit2ce3513c108a53bdcc5a838704867a4499295d85 (patch)
tree77681eee926bd532a2568dafab899d13691b0e8c /doc/drafts/admin-api.md
parente92c52eb6522a140cdced40bc047149dc638bfa4 (diff)
downloadgarage-2ce3513c108a53bdcc5a838704867a4499295d85.tar.gz
garage-2ce3513c108a53bdcc5a838704867a4499295d85.zip
Specify and implement {Global,Local}{Alias,Unalias}Bucket
Diffstat (limited to 'doc/drafts/admin-api.md')
-rw-r--r--doc/drafts/admin-api.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/doc/drafts/admin-api.md b/doc/drafts/admin-api.md
index 5dc3f127..14c4ec39 100644
--- a/doc/drafts/admin-api.md
+++ b/doc/drafts/admin-api.md
@@ -501,3 +501,22 @@ Request body format:
Flags in `permissions` which have the value `true` will be deactivated.
Other flags will remain unchanged.
+
+## Operations on bucket aliases
+
+### GlobalAliasBucket `PUT /bucket/alias/global?id=<bucket id>&alias=<global alias>`
+
+Empty body. Creates a global alias for a bucket.
+
+### GlobalUnaliasBucket `DELETE /bucket/alias/global?id=<bucket id>&alias=<global alias>`
+
+Removes a global alias for a bucket.
+
+### LocalAliasBucket `PUT /bucket/alias/local?id=<bucket id>&accessKeyId=<access key ID>&alias=<local alias>`
+
+Empty body. Creates a local alias for a bucket in the namespace of a specific access key.
+
+### LocalUnaliasBucket `DELETE /bucket/alias/local?id=<bucket id>&accessKeyId<access key ID>&alias=<local alias>`
+
+Removes a local alias for a bucket in the namespace of a specific access key.
+