Skip to content

docs(object): add API doc entries for SSE #6992

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
SamyOubouaziz merged 2 commits into from
Oct 15, 2026
Merged

docs(object): add API doc entries for SSE #6992

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a972f66
docs(object): add API doc entries for SSE
SamyOubouaziz Oct 13, 2026
003dda6
Apply batched suggestions from code review
SamyOubouaziz Oct 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 58 additions & 6 deletions pages/object-storage/api-cli/bucket-operations.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,26 @@ Host: bucketname.s3.nl-ams.scw.cloud
Authorization: authorization string
```

## DeleteBucketEncryption

This operation removes the default encryption configuration (SSE-ONE or SSE-KMS) of an existing bucket. Objects already stored in the bucket remain encrypted.

<Message type="note">
If the operation succeeds, no output is returned.
</Message>

**Sample request**
```sh no-copy
DELETE /?encryption HTTP/1.1
Host: bucketname.s3.nl-ams.scw.cloud
Authorization: authorization string
```

**CLI command**
```
aws s3api delete-bucket-encryption --bucket my-bucket
```

## DeleteBucketLifecycle

This operation deletes the lifecycle configuration of a specified bucket.
Expand Down Expand Up @@ -256,6 +276,38 @@ Date: Mon, 18 Mar 2019 10:41:42 GMT
</CORSRule>
</CORSConfiguration>
```

## GetBucketEncryption

This operation returns the default encryption configuration (SSE-ONE or SSE-KMS) of a bucket.

**Sample request**
```sh no-copy
GET /?encryption HTTP/1.1
Host: bucketname.s3.nl-ams.scw.cloud
Authorization: authorization string
```

**Sample response**
```xml no-copy
HTTP/1.1 200 OK

<?xml version="1.0" encoding="UTF-8"?>
<ServerSideEncryptionConfiguration xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
<Rule>
<ApplyServerSideEncryptionByDefault>
<SSEAlgorithm>AES256</SSEAlgorithm>
</ApplyServerSideEncryptionByDefault>
<BucketKeyEnabled>false</BucketKeyEnabled>
</Rule>
</ServerSideEncryptionConfiguration>
```

**CLI command**
```
aws s3api get-bucket-encryption --bucket my-bucket
```

## GetBucketLifecycleConfiguration

This operation returns information about the lifecycle configuration set on the bucket.
Expand Down Expand Up @@ -618,18 +670,19 @@ Authorization: authorization string

## PutBucketEncryption

This operation configures default encryption and Amazon S3 Bucket Keys for an existing bucket.
This operation sets the default encryption configuration (SSE-ONE or SSE-KMS) and the Bucket Key setting of an existing bucket.

<Message type="note">
If the operation is successful, no output will be returned.
</Message>

**Sample request**
```xml no-copy
PUT /?encryption HTTP/1.1
Host: Bucket.s3.amazonaws.com
Host: bucketname.s3.nl-ams.scw.cloud
Content-MD5: ContentMD5
x-amz-sdk-checksum-algorithm: ChecksumAlgorithm
x-amz-expected-bucket-owner: ExpectedBucketOwner
Authorization: authorization string

<?xml version="1.0" encoding="UTF-8"?>
<ServerSideEncryptionConfiguration xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
<Rule>
Expand All @@ -644,10 +697,9 @@ x-amz-expected-bucket-owner: ExpectedBucketOwner
```

**CLI command**

```bash
aws s3api put-bucket-encryption \
--bucket BucketName \
--bucket my-bucket \
--server-side-encryption-configuration '{"Rules": [{"ApplyServerSideEncryptionByDefault": {"SSEAlgorithm": "AES256"}}]}'
```

Expand Down
3 changes: 3 additions & 0 deletions pages/object-storage/api-cli/using-api-call-list.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,14 @@ In this page we index all available Scaleway Object Storage API requests.
| [CreateBucket](/object-storage/api-cli/bucket-operations/#createbucket) | Creates bucket | supported |
| [DeleteBucket](/object-storage/api-cli/bucket-operations/#deletebucket) | Deletes bucket | supported |
| [DeleteBucketCors](/object-storage/api-cli/bucket-operations/#deletebucketcors) | Deletes the [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing) configuration of a bucket | supported |
| [DeleteBucketEncryption](/object-storage/api-cli/bucket-operations/#deletebucketencryption) | Removes the default encryption configuration (SSE-ONE or SSE-KMS) of a bucket | supported |
| [DeleteBucketLifecycle](/object-storage/api-cli/bucket-operations/#deletebucketlifecycle)| Deletes the [lifecycle configuration](/object-storage/api-cli/lifecycle-rules-api/) of a bucket | supported |
| [DeleteBucketPolicy](/object-storage/api-cli/bucket-operations/#deletebucketpolicy) | Deletes the policy of a specified bucket | supported |
| [DeleteBucketTagging](/object-storage/api-cli/bucket-operations/#deletebuckettagging) | Deletes the tag(s) of a bucket | supported |
| [DeleteBucketWebsite](/object-storage/api-cli/bucket-operations/#deletebucketwebsite) | Deletes the bucket website configuration of a specified bucket | supported |
| [GetBucketAcl](/object-storage/api-cli/bucket-operations/#getbucketacl) | Returns the bucket ACL | supported |
| [GetBucketCors](/object-storage/api-cli/bucket-operations/#getbucketcors) | Returns the [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing) configuration of a bucket | supported |
| [GetBucketEncryption](/object-storage/api-cli/bucket-operations/#getbucketencryption) | Returns the default encryption configuration of a bucket | supported |
| GetBucketLifecycle | Returns the lifecycle configuration information set on the bucket | deprecated |
| [GetBucketLifecycleConfiguration](/object-storage/api-cli/bucket-operations/#getbucketlifecycleconfiguration) | Returns the lifecycle configuration information set on a bucket | supported |
| [GetBucketLocation](/object-storage/api-cli/bucket-operations/#getbucketlocation) | Returns the region where the bucket is | supported |
Expand All @@ -47,6 +49,7 @@ In this page we index all available Scaleway Object Storage API requests.
| [ListObjectVersions](/object-storage/api-cli/bucket-operations/#listobjectversions) | Returns metadata about all the versions of objects in a bucket | supported |
| [PutBucketAcl](/object-storage/api-cli/bucket-operations/#putbucketacl) | Configures the Access Control List of a bucket | supported |
| [PutBucketCors](/object-storage/api-cli/bucket-operations/#putbucketcors) | Configures [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing) on a bucket | supported |
| [PutBucketEncryption](/object-storage/api-cli/bucket-operations/#putbucketencryption) | Sets the default encryption configuration (SSE-ONE or SSE-KMS) of a bucket | supported |
| PutBucketLifecycle | Creates a new lifecycle configuration or replaces an existing bucket lifecycle configuration | deprecated |
| PutBucketLifecycleConfiguration| Creates a new lifecycle configuration or replaces an existing bucket lifecycle configuration | supported |
| PutBucketNotification | Enables notifications of specified events for a bucket | in development |
Expand Down
Loading