Skip to content
Merged
Changes from all commits
Commits
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
72 changes: 70 additions & 2 deletions src/content/docs/workers/wrangler/commands.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -932,6 +932,74 @@ List R2 bucket in the current account.
wrangler r2 bucket list
```

### `domain add`

Connect a [custom domain](/r2/buckets/public-buckets/#custom-domains) to an R2 bucket.

```txt
wrangler r2 bucket domain add <NAME> [OPTIONS]
```

- `NAME` <Type text="string" /> <MetaInfo text="required" />
- The name of the R2 bucket to connect a custom domain to.
- `--domain` <Type text="string" /> <MetaInfo text="required" />
- The custom domain to connect to the R2 bucket.
- `--zone-id` <Type text="string" /> <MetaInfo text="required" />
- The [zone ID](/fundamentals/setup/find-account-and-zone-ids/) associated with the custom domain.
- `--min-tls` <Type text="'1.0'|'1.1'|'1.2'|'1.3'" /> <MetaInfo text="optional" />
- Set the minimum TLS version for the custom domain (defaults to 1.0 if not set).
- `--jurisdiction` <Type text="string" /> <MetaInfo text="optional" />
- The jurisdiction where the bucket exists, if a jurisdiction has been specified. Refer to [jurisdictional restrictions](/r2/reference/data-location/#jurisdictional-restrictions).
- `--force` <Type text="boolean" /> <MetaInfo text="optional" />
- Skip confirmation when adding the custom domain.

### `domain remove`

Remove a [custom domain](/r2/buckets/public-buckets/#custom-domains) from an R2 bucket.

```txt
wrangler r2 bucket domain remove <NAME> [OPTIONS]
```

- `NAME` <Type text="string" /> <MetaInfo text="required" />
- The name of the R2 bucket to remove the custom domain from.
- `--domain` <Type text="string" /> <MetaInfo text="required" />
- The custom domain to remove from the R2 bucket.
- `--jurisdiction` <Type text="string" /> <MetaInfo text="optional" />
- The jurisdiction where the bucket exists, if a jurisdiction has been specified. Refer to [jurisdictional restrictions](/r2/reference/data-location/#jurisdictional-restrictions).
- `--force` <Type text="boolean" /> <MetaInfo text="optional" />
- Skip confirmation when removing the custom domain.

### `domain update`

Update settings for a [custom domain](/r2/buckets/public-buckets/#custom-domains) connected to an R2 bucket.

```txt
wrangler r2 bucket domain update <NAME> [OPTIONS]
```

- `NAME` <Type text="string" /> <MetaInfo text="required" />
- The name of the R2 bucket associated with the custom domain to update.
- `--domain` <Type text="string" /> <MetaInfo text="required" />
- The custom domain whose settings will be updated.
- `--min-tls` <Type text="'1.0'|'1.1'|'1.2'|'1.3'" /> <MetaInfo text="optional" />
- Update the minimum TLS version for the custom domain.
- `--jurisdiction` <Type text="string" /> <MetaInfo text="optional" />
- The jurisdiction where the bucket exists, if a jurisdiction has been specified. Refer to [jurisdictional restrictions](/r2/reference/data-location/#jurisdictional-restrictions).

### `domain list`

List [custom domains](/r2/buckets/public-buckets/#custom-domains) for an R2 bucket.

```txt
wrangler r2 bucket domain list <NAME> [OPTIONS]
```

- `NAME` <Type text="string" /> <MetaInfo text="required" />
- The name of the R2 bucket whose connected custom domains will be listed.
- `--jurisdiction` <Type text="string" /> <MetaInfo text="optional" />
- The jurisdiction where the bucket exists, if a jurisdiction has been specified. Refer to [jurisdictional restrictions](/r2/reference/data-location/#jurisdictional-restrictions).

### `notification create`

Create an [event notification](/r2/buckets/event-notifications/) rule for an R2 bucket.
Expand Down Expand Up @@ -998,7 +1066,7 @@ wrangler r2 bucket sippy enable <NAME> [OPTIONS]
- `--r2-secret-access-key` <Type text="string" /> <MetaInfo text="required" />
- Your R2 Secret Access Key. Requires read and write access.
- `--jurisdiction` <Type text="string" /> <MetaInfo text="optional" />
- The jurisdiction where this R2 bucket is located, if a jurisdiction has been specified. Refer to [Jurisdictional Restrictions](/r2/reference/data-location/#jurisdictional-restrictions).
- The jurisdiction where the bucket exists, if a jurisdiction has been specified. Refer to [jurisdictional restrictions](/r2/reference/data-location/#jurisdictional-restrictions).
- **AWS S3 provider-specific options:**
- `--key-id` <Type text="string" /> <MetaInfo text="optional" />
- Your AWS Access Key ID. Requires [read and list access](/r2/data-migration/sippy/#amazon-s3).
Expand Down Expand Up @@ -1270,7 +1338,7 @@ wrangler workflows list
```

- `--page` <Type text="number" /> <MetaInfo text="optional" />
- Show a specific page from the listing. You can configure page size using "per-page".
- Show a specific page from the listing. You can configure page size using "per-page".
- `--per-page` <Type text="number" /> <MetaInfo text="optional" />
- Configure the maximum number of Workflows to show per page.

Expand Down
Loading