API Reference

R2

Buckets

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Sippy

Get Sippy Configuration

client.r2.buckets.sippy.get(stringbucketName, SippyGetParams { account_id, jurisdiction } params?, RequestOptionsoptions?): Sippy { destination, enabled, source }

GET/accounts/{account_id}/r2/buckets/{bucket_name}/sippy

Enable Sippy

client.r2.buckets.sippy.update(stringbucketName, SippyUpdateParamsparams, RequestOptionsoptions?): Sippy { destination, enabled, source }

PUT/accounts/{account_id}/r2/buckets/{bucket_name}/sippy

Disable Sippy

client.r2.buckets.sippy.delete(stringbucketName, SippyDeleteParams { account_id, jurisdiction } params?, RequestOptionsoptions?): SippyDeleteResponse { enabled }

DELETE/accounts/{account_id}/r2/buckets/{bucket_name}/sippy

ModelsExpand Collapse

Provider = "r2"

Sippy { destination, enabled, source }

destination?: Destination { accessKeyId, account, bucket, provider }

Details about the configured destination bucket.

accessKeyId?: string

ID of the Cloudflare API token used when writing objects to this bucket.

account?: string

bucket?: string

Name of the bucket on the provider.

provider?: Provider { }

enabled?: boolean

State of Sippy for this bucket.

source?: Source { bucket, bucketUrl, provider, region }

Details about the configured source bucket.

bucket?: string | null

Name of the bucket on the provider (AWS, GCS only).

bucketUrl?: string | null

S3-compatible URL (Generic S3-compatible providers only).

provider?: "aws" | "gcs" | "s3"

One of the following:

"aws"

"gcs"

"s3"

region?: string | null

Region where the bucket resides (AWS only).

SippyDeleteResponse { enabled }

enabled?: false