Cloudflare API | R2 › Buckets › Sippy › Enable Sippy

API Reference

Account & User Management

Resource Sharing

AI

Certificate Management

Certificate Authorities

Client Certificates

Custom Certificates

Custom Hostnames

Keyless Certificates

MTLS Certificates

Origin CA Certificates

Origin Post Quantum Encryption

Origin TLS Client Auth

Cloudflare One

DNS

Account Custom Nameservers

Domain/Zone Management

IP Addresses

Media

Networking

Magic Network Monitoring

Observability

Radar

Routing & Performance

Rules

Cloud Connector

Managed Transforms

URL Normalization

Security

Content Scanning

Leaked Credential Checks

Storage & Databases

Event Notifications

Get Sippy Configuration

Temporary Credentials

Threat Intelligence

Brand Protection

Workers & Pages

Durable Objects

Workers For Platforms

Shared

R2

r2

Buckets

r2.buckets

Methods

Create Bucket -> Envelope<

>

post/accounts/{account_id}/r2/buckets

Creates a new R2 bucket.

Delete Bucket -> Envelope<unknown>

delete/accounts/{account_id}/r2/buckets/{bucket_name}

Deletes an existing R2 bucket.

Get Bucket -> Envelope<

>

get/accounts/{account_id}/r2/buckets/{bucket_name}

Gets metadata for an existing R2 bucket.

List Buckets -> Envelope<{ buckets }>

get/accounts/{account_id}/r2/buckets

Lists all R2 buckets on your account

Domain types

Bucket = { creation_date, location, name, 1 more... }

CORS

r2.buckets.cors

Methods

Delete Bucket CORS Policy -> Envelope<unknown>

delete/accounts/{account_id}/r2/buckets/{bucket_name}/cors

Delete the CORS policy for a bucket

Get Bucket CORS Policy -> Envelope<{ rules }>

get/accounts/{account_id}/r2/buckets/{bucket_name}/cors

Get the CORS policy for a bucket

Put Bucket CORS Policy -> Envelope<unknown>

put/accounts/{account_id}/r2/buckets/{bucket_name}/cors

Set the CORS policy for a bucket

Domains

r2.buckets.domains

R2 Buckets Domains

Custom

r2.buckets.domains.custom

Methods

Attach Custom Domain To Bucket -> Envelope<{ domain, enabled, minTLS }>

post/accounts/{account_id}/r2/buckets/{bucket_name}/domains/custom

Register a new custom domain for an existing R2 bucket.

Remove Custom Domain From Bucket -> Envelope<{ domain }>

delete/accounts/{account_id}/r2/buckets/{bucket_name}/domains/custom/{domain_name}

Remove custom domain registration from an existing R2 bucket

Get Custom Domain Settings -> Envelope<{ domain, enabled, status, 3 more... }>

get/accounts/{account_id}/r2/buckets/{bucket_name}/domains/custom/{domain_name}

Get the configuration for a custom domain on an existing R2 bucket.

List Custom Domains Of Bucket -> Envelope<{ domains }>

get/accounts/{account_id}/r2/buckets/{bucket_name}/domains/custom

Gets a list of all custom domains registered with an existing R2 bucket.

Configure Custom Domain Settings -> Envelope<{ domain, enabled, minTLS }>

put/accounts/{account_id}/r2/buckets/{bucket_name}/domains/custom/{domain_name}

Edit the configuration for a custom domain on an existing R2 bucket.

R2 Buckets Domains

Managed

r2.buckets.domains.managed

Methods

Get R2 Dev Domain Of Bucket -> Envelope<{ bucketId, domain, enabled }>

get/accounts/{account_id}/r2/buckets/{bucket_name}/domains/managed

Gets state of public access over the bucket's R2-managed (r2.dev) domain.

Update R2 Dev Domain Of Bucket -> Envelope<{ bucketId, domain, enabled }>

put/accounts/{account_id}/r2/buckets/{bucket_name}/domains/managed

Updates state of public access over the bucket's R2-managed (r2.dev) domain.

Event Notifications

r2.buckets.event_notifications

R2 Buckets Event Notifications

Configuration

r2.buckets.event_notifications.configuration

Methods

List Event Notification Rules -> Envelope<{ bucketName, queues }>

get/accounts/{account_id}/event_notifications/r2/{bucket_name}/configuration

List all event notification rules for a bucket.

R2 Buckets Event Notifications Configuration

Queues

r2.buckets.event_notifications.configuration.queues

Methods

Delete Event Notification Rules -> Envelope<unknown>

delete/accounts/{account_id}/event_notifications/r2/{bucket_name}/configuration/queues/{queue_id}

Delete an event notification rule. If no body is provided, all rules for specified queue will be deleted.

Create Event Notification Rule -> Envelope<unknown>

put/accounts/{account_id}/event_notifications/r2/{bucket_name}/configuration/queues/{queue_id}

Create event notification rule.

Lifecycle

r2.buckets.lifecycle

Methods

Get Object Lifecycle Rules -> Envelope<{ rules }>

get/accounts/{account_id}/r2/buckets/{bucket_name}/lifecycle

Get object lifecycle rules for a bucket

Put Object Lifecycle Rules -> Envelope<unknown>

put/accounts/{account_id}/r2/buckets/{bucket_name}/lifecycle

Set the object lifecycle rules for a bucket

Sippy

r2.buckets.sippy

Methods

Disable Sippy -> Envelope<{ enabled }>

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

Disables Sippy on this bucket

Get Sippy Configuration -> Envelope<

>

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

Gets configuration for Sippy for an existing R2 bucket.

Enable Sippy -> Envelope<

>

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

Sets configuration for Sippy for an existing R2 bucket.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example: Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

Parameters

account_id: string

Account ID

bucket_name: string

Name of the bucket

cf-r2-jurisdiction:

Optional

The bucket jurisdiction

"default"

"eu"

"fedramp"

Response fields

errors: Array<

>

messages: Array<string>

result:

success: true

Whether the API call was successful

Request example

curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/r2/buckets/$BUCKET_NAME/sippy \
    -X PUT \
    -H 'Content-Type: application/json' \
    -H "X-Auth-Email: $CLOUDFLARE_EMAIL" \
    -H "X-Auth-Key: $CLOUDFLARE_API_KEY" \
    -d '{}'

200Example

{
  "errors": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "messages": [
    "string"
  ],
  "result": {
    "destination": {
      "accessKeyId": "accessKeyId",
      "account": "account",
      "bucket": "bucket",
      "provider": "r2"
    },
    "enabled": true,
    "source": {
      "bucket": "bucket",
      "provider": "aws",
      "region": "region"
    }
  },
  "success": true
}

Domain types

Provider = "r2"

Sippy = { destination, enabled, source }

Temporary Credentials

r2.temporary_credentials

Methods

Create Temporary Access Credentials -> Envelope<{ accessKeyId, secretAccessKey, sessionToken }>

post/accounts/{account_id}/r2/temp-access-credentials

Creates temporary access credentials on a bucket that can be optionally scoped to prefixes or objects.

Domain types

TemporaryCredential = { bucket, parentAccessKeyId, permission, 3 more... }