API Reference

R2

Buckets

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Sippy

Get Sippy Configuration

r2.buckets.sippy.get(strbucket_name, SippyGetParams**kwargs) -> Sippy

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

Enable Sippy

r2.buckets.sippy.update(strbucket_name, SippyUpdateParams**kwargs) -> Sippy

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

Disable Sippy

r2.buckets.sippy.delete(strbucket_name, SippyDeleteParams**kwargs) -> SippyDeleteResponse

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

ModelsExpand Collapse

Literal["r2"]

class Sippy: …

destination: Optional[Destination]

Details about the configured destination bucket.

access_key_id: Optional[str]

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

account: Optional[str]

bucket: Optional[str]

Name of the bucket on the provider.

provider: Optional[Provider]

enabled: Optional[bool]

State of Sippy for this bucket.

source: Optional[Source]

Details about the configured source bucket.

bucket: Optional[str]

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

bucket_url: Optional[str]

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

provider: Optional[Literal["aws", "gcs", "s3"]]

One of the following:

"aws"

"gcs"

"s3"

region: Optional[str]

Region where the bucket resides (AWS only).

class SippyDeleteResponse: …

enabled: Optional[Literal[false]]