diff options
| author | Alex Auvolat <alex@adnab.me> | 2022-05-17 17:44:00 +0200 |
|---|---|---|
| committer | Alex Auvolat <alex@adnab.me> | 2022-05-17 17:44:00 +0200 |
| commit | 5072dbd2282736b3254627c26cfcf897505330e6 (patch) | |
| tree | 814c55b0798b4093de0f46a0528718e377e3e22d /doc | |
| parent | 2ce3513c108a53bdcc5a838704867a4499295d85 (diff) | |
| download | garage-5072dbd2282736b3254627c26cfcf897505330e6.tar.gz garage-5072dbd2282736b3254627c26cfcf897505330e6.zip | |
Add PutBucketWebsite and DeleteBucketWebsite to admin api
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/drafts/admin-api.md | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/doc/drafts/admin-api.md b/doc/drafts/admin-api.md index 14c4ec39..e8ed087d 100644 --- a/doc/drafts/admin-api.md +++ b/doc/drafts/admin-api.md @@ -457,6 +457,26 @@ Deletes a storage bucket. A bucket cannot be deleted if it is not empty. Warning: this will delete all aliases associated with the bucket! +### PutBucketWebsite `PUT /bucket/website?id=<bucket id>` + +Sets the website configuration for a bucket (this also enables website access for this bucket). + +Request body format: + +```json +{ + "indexDocument": "index.html", + "errorDocument": "404.html", +} +``` + +The field `errorDocument` is optional, if no error document is set a generic error message is displayed when errors happen. + + +### DeleteBucketWebsite `DELETE /bucket/website?id=<bucket id>` + +Deletes the website configuration for a bucket (disables website access for this bucket). + ## Operations on permissions for keys on buckets @@ -502,6 +522,7 @@ 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>` |