Skip to content

RS: SSE-C - #3883

Open
kaitlynmichael wants to merge 1 commit into
mainfrom
DOC-7009
Open

RS: SSE-C#3883
kaitlynmichael wants to merge 1 commit into
mainfrom
DOC-7009

Conversation

@kaitlynmichael

@kaitlynmichael kaitlynmichael commented Aug 27, 2026

Copy link
Copy Markdown
Contributor

Note

Low Risk
Documentation-only changes with no runtime or API implementation in this diff; risk is limited to doc accuracy and customer key-handling guidance.

Overview
Documents customer-provided S3 encryption (SSE-C) for Redis Software on-demand export and import over S3 and S3-compatible storage.

The docs add optional encryption objects (type: "sse-c", sse_customer_key as base64-encoded 32-byte AES-256 key) on export_location and S3 entries in dataset_import_sources, with JSON examples in the how-to pages and REST API reference (backup_location, dataset_import_sources, export/import actions).

They also state that SSE-C is request-scoped only: it works on export/import action requests and must not be stored in persisted backup_location or dataset_import_sources (requests fail if you try). Scheduled backups explicitly do not support SSE-C, with a note on the schedule-backups page linking to on-demand export/import.

Reviewed by Cursor Bugbot for commit 02afd59. Bugbot is set up for automated code reviews on this repo. Configure here.

@github-actions

github-actions Bot commented Aug 27, 2026

Copy link
Copy Markdown
Contributor

DOC-7009

@github-actions

Copy link
Copy Markdown
Contributor

🧠 Redis Memory

Found 5 related items from repository history (5 new this commit):

Memory updated at 02afd59

@dwdougherty dwdougherty left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I corrected a few relref specs. I'll go ahead and approve.

```

- `sse_customer_key` must be a base64-encoded string that decodes to exactly 32 bytes (AES-256).
- SSE-C encryption is only available for S3 and S3-compatible storage locations, and only for this one export request. You can't add `encryption` to a database's persisted [backup_location]({{<relref "/operate/rs/references/rest-api/objects/bdb/backup_location">}}) configuration, so SSE-C isn't available for [scheduled backups]({{<relref "/operate/rs/databases/import-export/schedule-backups.md">}}).

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- SSE-C encryption is only available for S3 and S3-compatible storage locations, and only for this one export request. You can't add `encryption` to a database's persisted [backup_location]({{<relref "/operate/rs/references/rest-api/objects/bdb/backup_location">}}) configuration, so SSE-C isn't available for [scheduled backups]({{<relref "/operate/rs/databases/import-export/schedule-backups.md">}}).
- SSE-C encryption is only available for S3 and S3-compatible storage locations, and only for this one export request. You can't add `encryption` to a database's persisted [backup_location]({{<relref "/operate/rs/references/rest-api/objects/bdb/backup_location">}}) configuration, so SSE-C isn't available for [scheduled backups]({{<relref "/operate/rs/databases/import-export/schedule-backups">}}).

Replace `<filepath>` with the location of the S3 CA certificate `ca.pem`.

{{< note >}}
Customer-provided encryption keys (SSE-C) aren't supported for scheduled backups. SSE-C is only available for on-demand [export]({{< relref "/operate/rs/databases/import-export/export-data.md" >}}) and [import]({{< relref "/operate/rs/databases/import-export/import-data.md" >}}) requests.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Customer-provided encryption keys (SSE-C) aren't supported for scheduled backups. SSE-C is only available for on-demand [export]({{< relref "/operate/rs/databases/import-export/export-data.md" >}}) and [import]({{< relref "/operate/rs/databases/import-export/import-data.md" >}}) requests.
Customer-provided encryption keys (SSE-C) aren't supported for scheduled backups. SSE-C is only available for on-demand [export]({{< relref "/operate/rs/databases/import-export/export-data" >}}) and [import]({{< relref "/operate/rs/databases/import-export/import-data" >}}) requests.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants