Skip to content

R2

Last updated View as MarkdownAgent setup

Manage your R2 configurations using Wrangler.

r2 bucket

Interact with buckets in an R2 store.

r2 bucket create

Create a new R2 bucket

npx wrangler r2 bucket create <NAME>
  • <NAME>string required

    The name of the new bucket

  • --locationstring

    The optional location hint that determines geographic placement of the R2 bucket

  • --storage-classstring alias: --s

    The default storage class for objects uploaded to this bucket

  • --jurisdictionstring alias: --J

    The jurisdiction where the new bucket will be created

  • --use-remoteboolean

    Use a remote binding when adding the newly created resource to your config

  • --update-configboolean

    Automatically update your config file with the newly added resource

  • --bindingstring

    The binding name of this resource in your Worker

Global flags

  • --vboolean alias: --version

    Show version number

  • --cwdstring

    Run as if Wrangler was started in the specified directory instead of the current working directory

  • --configstring alias: --c

    Path to Wrangler configuration file

  • --envstring alias: --e

    Environment to use for operations, and for selecting .env and .dev.vars files

  • --env-filestring

    Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

  • --install-skillsboolean default: false

    Install Cloudflare skills for detected AI coding agents before running the command

  • --profilestring

    Use a specific auth profile

r2 bucket info

Get information about an R2 bucket

npx wrangler r2 bucket info <BUCKET>
  • <BUCKET>string required

    The name of the bucket to retrieve info for

  • --jurisdictionstring alias: --J

    The jurisdiction where the bucket exists

  • --jsonboolean default: false

    Return the bucket information as JSON

Global flags

  • --vboolean alias: --version

    Show version number

  • --cwdstring

    Run as if Wrangler was started in the specified directory instead of the current working directory

  • --configstring alias: --c

    Path to Wrangler configuration file

  • --envstring alias: --e

    Environment to use for operations, and for selecting .env and .dev.vars files

  • --env-filestring

    Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

  • --install-skillsboolean default: false

    Install Cloudflare skills for detected AI coding agents before running the command

  • --profilestring

    Use a specific auth profile

r2 bucket delete

Delete an R2 bucket

npx wrangler r2 bucket delete <BUCKET>
  • <BUCKET>string required

    The name of the bucket to delete

  • --jurisdictionstring alias: --J

    The jurisdiction where the bucket exists

Global flags

  • --vboolean alias: --version

    Show version number

  • --cwdstring

    Run as if Wrangler was started in the specified directory instead of the current working directory

  • --configstring alias: --c

    Path to Wrangler configuration file

  • --envstring alias: --e

    Environment to use for operations, and for selecting .env and .dev.vars files

  • --env-filestring

    Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

  • --install-skillsboolean default: false

    Install Cloudflare skills for detected AI coding agents before running the command

  • --profilestring

    Use a specific auth profile

r2 bucket list

List R2 buckets

npx wrangler r2 bucket list
  • --jurisdictionstring alias: --J

    The jurisdiction to list

Global flags

  • --vboolean alias: --version

    Show version number

  • --cwdstring

    Run as if Wrangler was started in the specified directory instead of the current working directory

  • --configstring alias: --c

    Path to Wrangler configuration file

  • --envstring alias: --e

    Environment to use for operations, and for selecting .env and .dev.vars files

  • --env-filestring

    Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

  • --install-skillsboolean default: false

    Install Cloudflare skills for detected AI coding agents before running the command

  • --profilestring

    Use a specific auth profile

Basin Catalog

Enable Basin Catalog on a bucket:

npx wrangler basin catalog enable <BUCKET_NAME>

Disable Basin Catalog on a bucket:

npx wrangler basin catalog disable <BUCKET_NAME>

Get the Basin Catalog status for a bucket:

npx wrangler basin catalog get <BUCKET_NAME>

basin catalog compaction enable

Enable catalog-level compaction with a service token:

npx wrangler basin catalog compaction enable my-bucket --token <TOKEN>

Enable table-level compaction:

npx wrangler basin catalog compaction enable my-bucket my-namespace my-table --target-size 256

basin catalog compaction disable

Disable catalog-level compaction:

npx wrangler basin catalog compaction disable my-bucket

Disable table-level compaction:

npx wrangler basin catalog compaction disable my-bucket my-namespace my-table

Enable snapshot expiration:

npx wrangler basin catalog snapshot-expiration enable <BUCKET_NAME>

Disable snapshot expiration:

npx wrangler basin catalog snapshot-expiration disable <BUCKET_NAME>

r2 bucket cors set

Set the CORS configuration for an R2 bucket from a JSON file

npx wrangler r2 bucket cors set <BUCKET>
  • <BUCKET>string required

    The name of the R2 bucket to set the CORS configuration for

  • --filestring required

    Path to the JSON file containing the CORS configuration

  • --jurisdictionstring alias: --J

    The jurisdiction where the bucket exists

  • --forceboolean alias: --ydefault: false

    Skip confirmation

Global flags

  • --vboolean alias: --version

    Show version number

  • --cwdstring

    Run as if Wrangler was started in the specified directory instead of the current working directory

  • --configstring alias: --c

    Path to Wrangler configuration file

  • --envstring alias: --e

    Environment to use for operations, and for selecting .env and .dev.vars files

  • --env-filestring

    Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

  • --install-skillsboolean default: false

    Install Cloudflare skills for detected AI coding agents before running the command

  • --profilestring

    Use a specific auth profile

r2 bucket cors delete

Clear the CORS configuration for an R2 bucket

npx wrangler r2 bucket cors delete <BUCKET>
  • <BUCKET>string required

    The name of the R2 bucket to delete the CORS configuration for

  • --jurisdictionstring alias: --J

    The jurisdiction where the bucket exists

  • --forceboolean alias: --ydefault: false

    Skip confirmation

Global flags

  • --vboolean alias: --version

    Show version number

  • --cwdstring

    Run as if Wrangler was started in the specified directory instead of the current working directory

  • --configstring alias: --c

    Path to Wrangler configuration file

  • --envstring alias: --e

    Environment to use for operations, and for selecting .env and .dev.vars files

  • --env-filestring

    Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

  • --install-skillsboolean default: false

    Install Cloudflare skills for detected AI coding agents before running the command

  • --profilestring

    Use a specific auth profile

r2 bucket cors list

List the CORS rules for an R2 bucket

npx wrangler r2 bucket cors list <BUCKET>
  • <BUCKET>string required

    The name of the R2 bucket to list the CORS rules for

  • --jurisdictionstring alias: --J

    The jurisdiction where the bucket exists

Global flags

  • --vboolean alias: --version

    Show version number

  • --cwdstring

    Run as if Wrangler was started in the specified directory instead of the current working directory

  • --configstring alias: --c

    Path to Wrangler configuration file

  • --envstring alias: --e

    Environment to use for operations, and for selecting .env and .dev.vars files

  • --env-filestring

    Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

  • --install-skillsboolean default: false

    Install Cloudflare skills for detected AI coding agents before running the command

  • --profilestring

    Use a specific auth profile

r2 bucket dev-url enable

Enable public access via the r2.dev URL for an R2 bucket

npx wrangler r2 bucket dev-url enable <BUCKET>
  • <BUCKET>string required

    The name of the R2 bucket to enable public access via its r2.dev URL

  • --jurisdictionstring alias: --J

    The jurisdiction where the bucket exists

  • --forceboolean alias: --ydefault: false

    Skip confirmation

Global flags

  • --vboolean alias: --version

    Show version number

  • --cwdstring

    Run as if Wrangler was started in the specified directory instead of the current working directory

  • --configstring alias: --c

    Path to Wrangler configuration file

  • --envstring alias: --e

    Environment to use for operations, and for selecting .env and .dev.vars files

  • --env-filestring

    Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

  • --install-skillsboolean default: false

    Install Cloudflare skills for detected AI coding agents before running the command

  • --profilestring

    Use a specific auth profile

r2 bucket dev-url disable

Disable public access via the r2.dev URL for an R2 bucket

npx wrangler r2 bucket dev-url disable <BUCKET>
  • <BUCKET>string required

    The name of the R2 bucket to disable public access via its r2.dev URL

  • --jurisdictionstring alias: --J

    The jurisdiction where the bucket exists

  • --forceboolean alias: --ydefault: false

    Skip confirmation

Global flags

  • --vboolean alias: --version

    Show version number

  • --cwdstring

    Run as if Wrangler was started in the specified directory instead of the current working directory

  • --configstring alias: --c

    Path to Wrangler configuration file

  • --envstring alias: --e

    Environment to use for operations, and for selecting .env and .dev.vars files

  • --env-filestring

    Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

  • --install-skillsboolean default: false

    Install Cloudflare skills for detected AI coding agents before running the command

  • --profilestring

    Use a specific auth profile

r2 bucket dev-url get

Get the r2.dev URL and status for an R2 bucket

npx wrangler r2 bucket dev-url get <BUCKET>
  • <BUCKET>string required

    The name of the R2 bucket whose r2.dev URL status to retrieve

  • --jurisdictionstring alias: --J

    The jurisdiction where the bucket exists

Global flags

  • --vboolean alias: --version

    Show version number

  • --cwdstring

    Run as if Wrangler was started in the specified directory instead of the current working directory

  • --configstring alias: --c

    Path to Wrangler configuration file

  • --envstring alias: --e

    Environment to use for operations, and for selecting .env and .dev.vars files

  • --env-filestring

    Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

  • --install-skillsboolean default: false

    Install Cloudflare skills for detected AI coding agents before running the command

  • --profilestring

    Use a specific auth profile

r2 bucket domain add

Connect a custom domain to an R2 bucket

npx wrangler r2 bucket domain add <BUCKET>
  • <BUCKET>string required

    The name of the R2 bucket to connect a custom domain to

  • --domainstring required

    The custom domain to connect to the R2 bucket

  • --zone-idstring required

    The zone ID associated with the custom domain

  • --min-tlsstring

    Set the minimum TLS version for the custom domain (defaults to 1.0 if not set)

  • --jurisdictionstring alias: --J

    The jurisdiction where the bucket exists

  • --forceboolean alias: --ydefault: false

    Skip confirmation

Global flags

  • --vboolean alias: --version

    Show version number

  • --cwdstring

    Run as if Wrangler was started in the specified directory instead of the current working directory

  • --configstring alias: --c

    Path to Wrangler configuration file

  • --envstring alias: --e

    Environment to use for operations, and for selecting .env and .dev.vars files

  • --env-filestring

    Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

  • --install-skillsboolean default: false

    Install Cloudflare skills for detected AI coding agents before running the command

  • --profilestring

    Use a specific auth profile

r2 bucket domain remove

Remove a custom domain from an R2 bucket

npx wrangler r2 bucket domain remove <BUCKET>
  • <BUCKET>string required

    The name of the R2 bucket to remove the custom domain from

  • --domainstring required

    The custom domain to remove from the R2 bucket

  • --jurisdictionstring alias: --J

    The jurisdiction where the bucket exists

  • --forceboolean alias: --ydefault: false

    Skip confirmation

Global flags

  • --vboolean alias: --version

    Show version number

  • --cwdstring

    Run as if Wrangler was started in the specified directory instead of the current working directory

  • --configstring alias: --c

    Path to Wrangler configuration file

  • --envstring alias: --e

    Environment to use for operations, and for selecting .env and .dev.vars files

  • --env-filestring

    Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

  • --install-skillsboolean default: false

    Install Cloudflare skills for detected AI coding agents before running the command

  • --profilestring

    Use a specific auth profile

r2 bucket domain update

Update settings for a custom domain connected to an R2 bucket

npx wrangler r2 bucket domain update <BUCKET>
  • <BUCKET>string required

    The name of the R2 bucket associated with the custom domain to update

  • --domainstring required

    The custom domain whose settings will be updated

  • --min-tlsstring

    Update the minimum TLS version for the custom domain

  • --jurisdictionstring alias: --J

    The jurisdiction where the bucket exists

Global flags

  • --vboolean alias: --version

    Show version number

  • --cwdstring

    Run as if Wrangler was started in the specified directory instead of the current working directory

  • --configstring alias: --c

    Path to Wrangler configuration file

  • --envstring alias: --e

    Environment to use for operations, and for selecting .env and .dev.vars files

  • --env-filestring

    Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

  • --install-skillsboolean default: false

    Install Cloudflare skills for detected AI coding agents before running the command

  • --profilestring

    Use a specific auth profile

r2 bucket domain get

Get custom domain connected to an R2 bucket

npx wrangler r2 bucket domain get <BUCKET>
  • <BUCKET>string required

    The name of the R2 bucket whose custom domain to retrieve

  • --domainstring required

    The custom domain to get information for

  • --jurisdictionstring alias: --J

    The jurisdiction where the bucket exists

Global flags

  • --vboolean alias: --version

    Show version number

  • --cwdstring

    Run as if Wrangler was started in the specified directory instead of the current working directory

  • --configstring alias: --c

    Path to Wrangler configuration file

  • --envstring alias: --e

    Environment to use for operations, and for selecting .env and .dev.vars files

  • --env-filestring

    Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

  • --install-skillsboolean default: false

    Install Cloudflare skills for detected AI coding agents before running the command

  • --profilestring

    Use a specific auth profile

r2 bucket domain list

List custom domains for an R2 bucket

npx wrangler r2 bucket domain list <BUCKET>
  • <BUCKET>string required

    The name of the R2 bucket whose connected custom domains will be listed

  • --jurisdictionstring alias: --J

    The jurisdiction where the bucket exists

Global flags

  • --vboolean alias: --version

    Show version number

  • --cwdstring

    Run as if Wrangler was started in the specified directory instead of the current working directory

  • --configstring alias: --c

    Path to Wrangler configuration file

  • --envstring alias: --e

    Environment to use for operations, and for selecting .env and .dev.vars files

  • --env-filestring

    Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

  • --install-skillsboolean default: false

    Install Cloudflare skills for detected AI coding agents before running the command

  • --profilestring

    Use a specific auth profile

r2 bucket lifecycle add

Add a lifecycle rule to an R2 bucket

npx wrangler r2 bucket lifecycle add <BUCKET> [NAME] [PREFIX]
  • <BUCKET>string required

    The name of the R2 bucket to add a lifecycle rule to

  • [NAME]string alias: --id

    A unique name for the lifecycle rule, used to identify and manage it.

  • [PREFIX]string

    Prefix condition for the lifecycle rule (leave empty for all prefixes)

  • --expire-daysnumber

    Number of days after which objects expire

  • --expire-datestring

    Date after which objects expire (YYYY-MM-DD)

  • --ia-transition-daysnumber

    Number of days after which objects transition to Infrequent Access storage

  • --ia-transition-datestring

    Date after which objects transition to Infrequent Access storage (YYYY-MM-DD)

  • --abort-multipart-daysnumber

    Number of days after which incomplete multipart uploads are aborted

  • --jurisdictionstring alias: --J

    The jurisdiction where the bucket exists

  • --forceboolean alias: --ydefault: false

    Skip confirmation and data catalog validation prompt

Global flags

  • --vboolean alias: --version

    Show version number

  • --cwdstring

    Run as if Wrangler was started in the specified directory instead of the current working directory

  • --configstring alias: --c

    Path to Wrangler configuration file

  • --envstring alias: --e

    Environment to use for operations, and for selecting .env and .dev.vars files

  • --env-filestring

    Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

  • --install-skillsboolean default: false

    Install Cloudflare skills for detected AI coding agents before running the command

  • --profilestring

    Use a specific auth profile

r2 bucket lifecycle remove

Remove a lifecycle rule from an R2 bucket

npx wrangler r2 bucket lifecycle remove <BUCKET>
  • <BUCKET>string required

    The name of the R2 bucket to remove a lifecycle rule from

  • --namestring alias: --idrequired

    The unique name of the lifecycle rule to remove

  • --jurisdictionstring alias: --J

    The jurisdiction where the bucket exists

Global flags

  • --vboolean alias: --version

    Show version number

  • --cwdstring

    Run as if Wrangler was started in the specified directory instead of the current working directory

  • --configstring alias: --c

    Path to Wrangler configuration file

  • --envstring alias: --e

    Environment to use for operations, and for selecting .env and .dev.vars files

  • --env-filestring

    Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

  • --install-skillsboolean default: false

    Install Cloudflare skills for detected AI coding agents before running the command

  • --profilestring

    Use a specific auth profile

r2 bucket lifecycle list

List lifecycle rules for an R2 bucket

npx wrangler r2 bucket lifecycle list <BUCKET>
  • <BUCKET>string required

    The name of the R2 bucket to list lifecycle rules for

  • --jurisdictionstring alias: --J

    The jurisdiction where the bucket exists

Global flags

  • --vboolean alias: --version

    Show version number

  • --cwdstring

    Run as if Wrangler was started in the specified directory instead of the current working directory

  • --configstring alias: --c

    Path to Wrangler configuration file

  • --envstring alias: --e

    Environment to use for operations, and for selecting .env and .dev.vars files

  • --env-filestring

    Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

  • --install-skillsboolean default: false

    Install Cloudflare skills for detected AI coding agents before running the command

  • --profilestring

    Use a specific auth profile

r2 bucket lifecycle set

Set the lifecycle configuration for an R2 bucket from a JSON file

npx wrangler r2 bucket lifecycle set <BUCKET>
  • <BUCKET>string required

    The name of the R2 bucket to set lifecycle configuration for

  • --filestring required

    Path to the JSON file containing lifecycle configuration

  • --jurisdictionstring alias: --J

    The jurisdiction where the bucket exists

  • --forceboolean alias: --ydefault: false

    Skip confirmation and data catalog validation prompt

Global flags

  • --vboolean alias: --version

    Show version number

  • --cwdstring

    Run as if Wrangler was started in the specified directory instead of the current working directory

  • --configstring alias: --c

    Path to Wrangler configuration file

  • --envstring alias: --e

    Environment to use for operations, and for selecting .env and .dev.vars files

  • --env-filestring

    Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

  • --install-skillsboolean default: false

    Install Cloudflare skills for detected AI coding agents before running the command

  • --profilestring

    Use a specific auth profile

r2 bucket lock add

Add a lock rule to an R2 bucket

npx wrangler r2 bucket lock add <BUCKET> [NAME] [PREFIX]
  • <BUCKET>string required

    The name of the R2 bucket to add a bucket lock rule to

  • [NAME]string alias: --id

    A unique name for the bucket lock rule, used to identify and manage it.

  • [PREFIX]string

    Prefix condition for the bucket lock rule (set to "" for all prefixes)

  • --retention-daysnumber

    Number of days which objects will be retained for

  • --retention-datestring

    Date after which objects will be retained until (YYYY-MM-DD)

  • --retention-indefiniteboolean

    Retain objects indefinitely

  • --jurisdictionstring alias: --J

    The jurisdiction where the bucket exists

  • --forceboolean alias: --ydefault: false

    Skip confirmation

Global flags

  • --vboolean alias: --version

    Show version number

  • --cwdstring

    Run as if Wrangler was started in the specified directory instead of the current working directory

  • --configstring alias: --c

    Path to Wrangler configuration file

  • --envstring alias: --e

    Environment to use for operations, and for selecting .env and .dev.vars files

  • --env-filestring

    Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

  • --install-skillsboolean default: false

    Install Cloudflare skills for detected AI coding agents before running the command

  • --profilestring

    Use a specific auth profile

r2 bucket lock remove

Remove a bucket lock rule from an R2 bucket

npx wrangler r2 bucket lock remove <BUCKET>
  • <BUCKET>string required

    The name of the R2 bucket to remove a bucket lock rule from

  • --namestring alias: --idrequired

    The unique name of the bucket lock rule to remove

  • --jurisdictionstring alias: --J

    The jurisdiction where the bucket exists

Global flags

  • --vboolean alias: --version

    Show version number

  • --cwdstring

    Run as if Wrangler was started in the specified directory instead of the current working directory

  • --configstring alias: --c

    Path to Wrangler configuration file

  • --envstring alias: --e

    Environment to use for operations, and for selecting .env and .dev.vars files

  • --env-filestring

    Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

  • --install-skillsboolean default: false

    Install Cloudflare skills for detected AI coding agents before running the command

  • --profilestring

    Use a specific auth profile

r2 bucket lock list

List lock rules for an R2 bucket

npx wrangler r2 bucket lock list <BUCKET>
  • <BUCKET>string required

    The name of the R2 bucket to list lock rules for

  • --jurisdictionstring alias: --J

    The jurisdiction where the bucket exists

Global flags

  • --vboolean alias: --version

    Show version number

  • --cwdstring

    Run as if Wrangler was started in the specified directory instead of the current working directory

  • --configstring alias: --c

    Path to Wrangler configuration file

  • --envstring alias: --e

    Environment to use for operations, and for selecting .env and .dev.vars files

  • --env-filestring

    Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

  • --install-skillsboolean default: false

    Install Cloudflare skills for detected AI coding agents before running the command

  • --profilestring

    Use a specific auth profile

r2 bucket lock set

Set the lock configuration for an R2 bucket from a JSON file

npx wrangler r2 bucket lock set <BUCKET>
  • <BUCKET>string required

    The name of the R2 bucket to set lock configuration for

  • --filestring required

    Path to the JSON file containing lock configuration

  • --jurisdictionstring alias: --J

    The jurisdiction where the bucket exists

  • --forceboolean alias: --ydefault: false

    Skip confirmation

Global flags

  • --vboolean alias: --version

    Show version number

  • --cwdstring

    Run as if Wrangler was started in the specified directory instead of the current working directory

  • --configstring alias: --c

    Path to Wrangler configuration file

  • --envstring alias: --e

    Environment to use for operations, and for selecting .env and .dev.vars files

  • --env-filestring

    Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

  • --install-skillsboolean default: false

    Install Cloudflare skills for detected AI coding agents before running the command

  • --profilestring

    Use a specific auth profile

r2 bucket notification create

Create an event notification rule for an R2 bucket

npx wrangler r2 bucket notification create <BUCKET>
  • <BUCKET>string required

    The name of the R2 bucket to create an event notification rule for

  • --event-types"object-create" | "object-delete" alias: --event-typerequired

    The type of event(s) that will emit event notifications

  • --prefixstring

    The prefix that an object must match to emit event notifications (note: regular expressions not supported)

  • --suffixstring

    The suffix that an object must match to emit event notifications (note: regular expressions not supported)

  • --queuestring required

    The name of the queue that will receive event notification messages

  • --jurisdictionstring alias: --J

    The jurisdiction where the bucket exists

  • --descriptionstring

    A description that can be used to identify the event notification rule after creation

Global flags

  • --vboolean alias: --version

    Show version number

  • --cwdstring

    Run as if Wrangler was started in the specified directory instead of the current working directory

  • --configstring alias: --c

    Path to Wrangler configuration file

  • --envstring alias: --e

    Environment to use for operations, and for selecting .env and .dev.vars files

  • --env-filestring

    Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

  • --install-skillsboolean default: false

    Install Cloudflare skills for detected AI coding agents before running the command

  • --profilestring

    Use a specific auth profile

r2 bucket notification delete

Delete an event notification rule from an R2 bucket

npx wrangler r2 bucket notification delete <BUCKET>
  • <BUCKET>string required

    The name of the R2 bucket to delete an event notification rule for

  • --queuestring required

    The name of the queue that corresponds to the event notification rule. If no rule is provided, all event notification rules associated with the bucket and queue will be deleted

  • --rulestring

    The ID of the event notification rule to delete

  • --jurisdictionstring alias: --J

    The jurisdiction where the bucket exists

Global flags

  • --vboolean alias: --version

    Show version number

  • --cwdstring

    Run as if Wrangler was started in the specified directory instead of the current working directory

  • --configstring alias: --c

    Path to Wrangler configuration file

  • --envstring alias: --e

    Environment to use for operations, and for selecting .env and .dev.vars files

  • --env-filestring

    Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

  • --install-skillsboolean default: false

    Install Cloudflare skills for detected AI coding agents before running the command

  • --profilestring

    Use a specific auth profile

r2 bucket notification list

List event notification rules for an R2 bucket

npx wrangler r2 bucket notification list <BUCKET>
  • <BUCKET>string required

    The name of the R2 bucket to get event notification rules for

  • --jurisdictionstring alias: --J

    The jurisdiction where the bucket exists

Global flags

  • --vboolean alias: --version

    Show version number

  • --cwdstring

    Run as if Wrangler was started in the specified directory instead of the current working directory

  • --configstring alias: --c

    Path to Wrangler configuration file

  • --envstring alias: --e

    Environment to use for operations, and for selecting .env and .dev.vars files

  • --env-filestring

    Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

  • --install-skillsboolean default: false

    Install Cloudflare skills for detected AI coding agents before running the command

  • --profilestring

    Use a specific auth profile

r2 bucket sippy enable

Enable Sippy on an R2 bucket

npx wrangler r2 bucket sippy enable <NAME>
  • <NAME>string required

    The name of the bucket

  • --jurisdictionstring alias: --J

    The jurisdiction where the bucket exists

  • --provider"AWS" | "GCS"
  • --bucketstring

    The name of the upstream bucket

  • --regionstring

    (AWS provider only) The region of the upstream bucket

  • --access-key-idstring

    (AWS provider only) The secret access key id for the upstream bucket

  • --secret-access-keystring

    (AWS provider only) The secret access key for the upstream bucket

  • --service-account-key-filestring

    (GCS provider only) The path to your Google Cloud service account key JSON file

  • --client-emailstring

    (GCS provider only) The client email for your Google Cloud service account key

  • --private-keystring

    (GCS provider only) The private key for your Google Cloud service account key

  • --r2-access-key-idstring

    The secret access key id for this R2 bucket

  • --r2-secret-access-keystring

    The secret access key for this R2 bucket

Global flags

  • --vboolean alias: --version

    Show version number

  • --cwdstring

    Run as if Wrangler was started in the specified directory instead of the current working directory

  • --configstring alias: --c

    Path to Wrangler configuration file

  • --envstring alias: --e

    Environment to use for operations, and for selecting .env and .dev.vars files

  • --env-filestring

    Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

  • --install-skillsboolean default: false

    Install Cloudflare skills for detected AI coding agents before running the command

  • --profilestring

    Use a specific auth profile

r2 bucket sippy disable

Disable Sippy on an R2 bucket

npx wrangler r2 bucket sippy disable <NAME>
  • <NAME>string required

    The name of the bucket

  • --jurisdictionstring alias: --J

    The jurisdiction where the bucket exists

Global flags

  • --vboolean alias: --version

    Show version number

  • --cwdstring

    Run as if Wrangler was started in the specified directory instead of the current working directory

  • --configstring alias: --c

    Path to Wrangler configuration file

  • --envstring alias: --e

    Environment to use for operations, and for selecting .env and .dev.vars files

  • --env-filestring

    Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

  • --install-skillsboolean default: false

    Install Cloudflare skills for detected AI coding agents before running the command

  • --profilestring

    Use a specific auth profile

r2 bucket sippy get

Check the status of Sippy on an R2 bucket

npx wrangler r2 bucket sippy get <NAME>
  • <NAME>string required

    The name of the bucket

  • --jurisdictionstring alias: --J

    The jurisdiction where the bucket exists

Global flags

  • --vboolean alias: --version

    Show version number

  • --cwdstring

    Run as if Wrangler was started in the specified directory instead of the current working directory

  • --configstring alias: --c

    Path to Wrangler configuration file

  • --envstring alias: --e

    Environment to use for operations, and for selecting .env and .dev.vars files

  • --env-filestring

    Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

  • --install-skillsboolean default: false

    Install Cloudflare skills for detected AI coding agents before running the command

  • --profilestring

    Use a specific auth profile

r2 object

Interact with R2 objects.

r2 object get

Fetch an object from an R2 bucket

npx wrangler r2 object get <OBJECTPATH>
  • <OBJECTPATH>string required

    The source object path in the form of {bucket}/{key}

  • --filestring alias: --f

    The destination file to create

  • --pipeboolean alias: --p

    Enables the file to be piped to a destination, rather than specified with the --file option

  • --localboolean

    Interact with local storage

  • --remoteboolean

    Interact with remote storage

  • --persist-tostring

    Directory for local persistence

  • --jurisdictionstring alias: --J

    The jurisdiction where the object exists

Global flags

  • --vboolean alias: --version

    Show version number

  • --cwdstring

    Run as if Wrangler was started in the specified directory instead of the current working directory

  • --configstring alias: --c

    Path to Wrangler configuration file

  • --envstring alias: --e

    Environment to use for operations, and for selecting .env and .dev.vars files

  • --env-filestring

    Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

  • --install-skillsboolean default: false

    Install Cloudflare skills for detected AI coding agents before running the command

  • --profilestring

    Use a specific auth profile

r2 object put

Create an object in an R2 bucket

npx wrangler r2 object put <OBJECTPATH>
  • <OBJECTPATH>string required

    The destination object path in the form of {bucket}/{key}

  • --content-typestring alias: --ct

    A standard MIME type describing the format of the object data

  • --content-dispositionstring alias: --cd

    Specifies presentational information for the object

  • --content-encodingstring alias: --ce

    Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field

  • --content-languagestring alias: --cl

    The language the content is in

  • --cache-controlstring alias: --cc

    Specifies caching behavior along the request/reply chain

  • --expiresstring

    The date and time at which the object is no longer cacheable

  • --localboolean

    Interact with local storage

  • --remoteboolean

    Interact with remote storage

  • --persist-tostring

    Directory for local persistence

  • --jurisdictionstring alias: --J

    The jurisdiction where the object will be created

  • --storage-classstring alias: --s

    The storage class of the object to be created

  • --forceboolean alias: --ydefault: false

    Skip data catalog validation prompt

  • --filestring alias: --f

    The path of the file to upload

  • --pipeboolean alias: --p

    Enables the file to be piped in, rather than specified with the --file option

Global flags

  • --vboolean alias: --version

    Show version number

  • --cwdstring

    Run as if Wrangler was started in the specified directory instead of the current working directory

  • --configstring alias: --c

    Path to Wrangler configuration file

  • --envstring alias: --e

    Environment to use for operations, and for selecting .env and .dev.vars files

  • --env-filestring

    Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

  • --install-skillsboolean default: false

    Install Cloudflare skills for detected AI coding agents before running the command

  • --profilestring

    Use a specific auth profile

r2 object delete

Delete an object in an R2 bucket

npx wrangler r2 object delete <OBJECTPATH>
  • <OBJECTPATH>string required

    The destination object path in the form of {bucket}/{key}

  • --localboolean

    Interact with local storage

  • --remoteboolean

    Interact with remote storage

  • --persist-tostring

    Directory for local persistence

  • --jurisdictionstring alias: --J

    The jurisdiction where the object exists

  • --forceboolean alias: --ydefault: false

    Skip data catalog validation prompt

Global flags

  • --vboolean alias: --version

    Show version number

  • --cwdstring

    Run as if Wrangler was started in the specified directory instead of the current working directory

  • --configstring alias: --c

    Path to Wrangler configuration file

  • --envstring alias: --e

    Environment to use for operations, and for selecting .env and .dev.vars files

  • --env-filestring

    Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

  • --install-skillsboolean default: false

    Install Cloudflare skills for detected AI coding agents before running the command

  • --profilestring

    Use a specific auth profile

Basin SQL

npx wrangler basin sql query <WAREHOUSE_NAME> "SELECT * FROM <NAMESPACE>.<TABLE> LIMIT 10"

For more information, refer to Basin SQL Wrangler commands.

Was this helpful?