Skip to content

Commit b76285c

Browse files
committed
Add R2 bucket lock changelog entry + update bucket lock docs
1 parent 6d32d88 commit b76285c

File tree

2 files changed

+44
-0
lines changed

2 files changed

+44
-0
lines changed
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
title: Set retention polices for your R2 bucket with bucket locks
3+
description: Set retention polices for your R2 bucket with bucket locks
4+
products:
5+
- r2
6+
date: 2025-03-06T10:00:00Z
7+
---
8+
9+
You can now use [bucket locks](/r2/buckets/bucket-locks/) to set retention policies on your [R2 buckets](/r2/buckets/) (or specific prefixes within your buckets) for a specified period — or indefinitely. This can help ensure compliance by protecting important data from accidental or malicious deletion.
10+
11+
Buckets can have up to 1,000 [bucket lock rules](/r2/buckets/). Each rule specifies which objects it covers (via prefix) and how long those objects must remain retained. You can:
12+
13+
- Lock objects for a specific duration. For example, 90 days.
14+
- Retain objects until a certain date. For example, until January 1, 2030.
15+
- Keep objects locked indefinitely.
16+
17+
Here's how you can add a bucket lock rule with [Wrangler](/workers/wrangler/):
18+
19+
```sh
20+
npx wrangler r2 bucket lock add my-bucket
21+
```
22+
23+
For more information on bucket locks and how to set retention policies for objects in your R2 buckets, refer to our [documentation](/r2/buckets/bucket-locks/).

src/content/docs/r2/buckets/bucket-locks.mdx

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,14 @@ Before getting started, you will need:
1212
- An existing R2 bucket. If you do not already have an existing R2 bucket, refer to [Create buckets](/r2/buckets/create-buckets/).
1313
- (API only) An API token with [permissions](/r2/api/s3/tokens/#permissions) to edit R2 bucket configuration.
1414

15+
### Enable bucket lock via Dashboard
16+
17+
1. From the Cloudflare dashboard, select **R2** from the sidebar.
18+
2. Select the bucket you'd like to add bucket lock rule to.
19+
3. Switch to the **Settings** tab, then scroll down to the **Bucket lock rules** card.
20+
4. Select **Add rule** and enter the rule name, prefix, and retention period.
21+
5. Select **Save changes**.
22+
1523
### Enable bucket lock via Wrangler
1624

1725
1. Install [`npm`](https://docs.npmjs.com/getting-started).
@@ -77,6 +85,12 @@ If your bucket is setup with [jurisdictional restrictions](/r2/reference/data-lo
7785

7886
## Get bucket lock rules for your R2 bucket
7987

88+
### Dashboard
89+
90+
1. From the Cloudflare dashboard, select **R2** from the sidebar.
91+
2. Select the bucket you'd like to add bucket lock rule to.
92+
3. Switch to the **Settings** tab, then scroll down to the **Bucket lock rules** card.
93+
8094
### Wrangler
8195

8296
To list bucket lock rules, run the [`r2 bucket lock list` command](/workers/wrangler/commands/#r2-bucket-lock-list):
@@ -91,6 +105,13 @@ For more information on required parameters and examples of how to get bucket lo
91105

92106
## Remove bucket lock rules from your R2 bucket
93107

108+
### Dashboard
109+
110+
1. From the Cloudflare dashboard, select **R2** from the sidebar.
111+
2. Select the bucket you'd like to add bucket lock rule to.
112+
3. Switch to the **Settings** tab, then scroll down to the **Bucket lock rules** card.
113+
4. Locate the rule you want to remove, select the `...` icon next to it, and then select **Delete**.
114+
94115
### Wrangler
95116

96117
To remove a bucket lock rule, run the [`r2 bucket lock remove` command](/workers/wrangler/commands/#r2-bucket-lock-remove):

0 commit comments

Comments
 (0)