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(ctx, bucketName, params) (*Sippy, error)

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

Enable Sippy

client.R2.Buckets.Sippy.Update(ctx, bucketName, params) (*Sippy, error)

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

Disable Sippy

client.R2.Buckets.Sippy.Delete(ctx, bucketName, params) (*BucketSippyDeleteResponse, error)

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

ModelsExpand Collapse

type Provider string

type Sippy struct{…}

Destination SippyDestinationoptional

Details about the configured destination bucket.

AccessKeyID stringoptional

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

Account stringoptional

Bucket stringoptional

Name of the bucket on the provider.

Provider Provideroptional

Enabled booloptional

State of Sippy for this bucket.

Source SippySourceoptional

Details about the configured source bucket.

Bucket stringoptional

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

BucketURL stringoptional

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

Provider SippySourceProvideroptional

One of the following:

const SippySourceProviderAws SippySourceProvider = "aws"

const SippySourceProviderGcs SippySourceProvider = "gcs"

const SippySourceProviderS3 SippySourceProvider = "s3"

Region stringoptional

Region where the bucket resides (AWS only).