--- title: R2 --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # R2 #### R2Buckets ##### [List Buckets](https://developers.cloudflare.com/api/resources/r2/subresources/buckets/methods/list) GET/accounts/{account\_id}/r2/buckets ##### [Get Bucket](https://developers.cloudflare.com/api/resources/r2/subresources/buckets/methods/get) GET/accounts/{account\_id}/r2/buckets/{bucket\_name} ##### [Create Bucket](https://developers.cloudflare.com/api/resources/r2/subresources/buckets/methods/create) POST/accounts/{account\_id}/r2/buckets ##### [Patch Bucket](https://developers.cloudflare.com/api/resources/r2/subresources/buckets/methods/edit) PATCH/accounts/{account\_id}/r2/buckets/{bucket\_name} ##### [Delete Bucket](https://developers.cloudflare.com/api/resources/r2/subresources/buckets/methods/delete) DELETE/accounts/{account\_id}/r2/buckets/{bucket\_name} ##### ModelsExpand Collapse
Bucket object {creation\_date, jurisdiction, location, 2 more } A single R2 bucket. creation\_date: optional string Creation timestamp. Link to this property
jurisdiction: optional "default"or "eu"or "us"or 2 more Jurisdiction where objects in this bucket are guaranteed to be stored. One of the following: "default" Link to this property "eu" Link to this property "us" Link to this property "fedramp" Link to this property "fedramp-high" Link to this property
Link to this property
location: optional "apac"or "eeur"or "enam"or 3 more Location of the bucket. One of the following: "apac" Link to this property "eeur" Link to this property "enam" Link to this property "weur" Link to this property "wnam" Link to this property "oc" Link to this property
Link to this property name: optional string Name of the bucket. maxLength64 minLength3 Link to this property
storage\_class: optional "Standard"or "InfrequentAccess" Storage class for newly uploaded objects, unless specified otherwise. One of the following: "Standard" Link to this property "InfrequentAccess" Link to this property
Link to this property
[Link to this property](<#(resource)%20r2.buckets%20%3E%20(model)%20bucket%20%3E%20(schema)>)
BucketListResponse object {buckets }
buckets: optional array of Bucket { creation\_date, jurisdiction, location, 2 more } creation\_date: optional string Creation timestamp. Link to this property
jurisdiction: optional "default"or "eu"or "us"or 2 more Jurisdiction where objects in this bucket are guaranteed to be stored. One of the following: "default" Link to this property "eu" Link to this property "us" Link to this property "fedramp" Link to this property "fedramp-high" Link to this property
Link to this property
location: optional "apac"or "eeur"or "enam"or 3 more Location of the bucket. One of the following: "apac" Link to this property "eeur" Link to this property "enam" Link to this property "weur" Link to this property "wnam" Link to this property "oc" Link to this property
Link to this property name: optional string Name of the bucket. maxLength64 minLength3 Link to this property
storage\_class: optional "Standard"or "InfrequentAccess" Storage class for newly uploaded objects, unless specified otherwise. One of the following: "Standard" Link to this property "InfrequentAccess" Link to this property
Link to this property
Link to this property
[Link to this property](<#(resource)%20r2.buckets%20%3E%20(model)%20bucket_list_response%20%3E%20(schema)>) BucketDeleteResponse = unknown [Link to this property](<#(resource)%20r2.buckets%20%3E%20(model)%20bucket_delete_response%20%3E%20(schema)>) #### R2BucketsLifecycle ##### [Get Object Lifecycle Rules](https://developers.cloudflare.com/api/resources/r2/subresources/buckets/subresources/lifecycle/methods/get) GET/accounts/{account\_id}/r2/buckets/{bucket\_name}/lifecycle ##### [Set Object Lifecycle Rules](https://developers.cloudflare.com/api/resources/r2/subresources/buckets/subresources/lifecycle/methods/update) PUT/accounts/{account\_id}/r2/buckets/{bucket\_name}/lifecycle ##### ModelsExpand Collapse
LifecycleGetResponse object {rules }
rules: optional array of object {id, conditions, enabled, 3 more } id: string Unique identifier for this rule. Link to this property
conditions: object {prefix } Conditions that apply to all transitions of this rule. prefix: string Transitions will only apply to objects/uploads in the bucket that start with the given prefix, an empty prefix can be provided to scope rule to all objects/uploads. Link to this property
Link to this property enabled: boolean Whether or not this rule is in effect. Link to this property
abortMultipartUploadsTransition: optional object {condition } Transition to abort ongoing multipart uploads.
condition: optional object {maxAge, type } Condition for lifecycle transitions to apply after an object reaches an age in seconds. maxAge: number Link to this property type: "Age" Link to this property
Link to this property
Link to this property
deleteObjectsTransition: optional object {condition } Transition to delete objects.
condition: optional object {maxAge, type } or object {date, type } Condition for lifecycle transitions to apply after an object reaches an age in seconds. One of the following:
R2LifecycleAgeCondition object {maxAge, type } Condition for lifecycle transitions to apply after an object reaches an age in seconds. maxAge: number Link to this property type: "Age" Link to this property
Link to this property
R2LifecycleDateCondition object {date, type } Condition for lifecycle transitions to apply on a specific date. date: string formatdate-time Link to this property type: "Date" Link to this property
Link to this property
Link to this property
Link to this property
storageClassTransitions: optional array of object {condition, storageClass } Transitions to change the storage class of objects.
condition: object {maxAge, type } or object {date, type } Condition for lifecycle transitions to apply after an object reaches an age in seconds. One of the following:
R2LifecycleAgeCondition object {maxAge, type } Condition for lifecycle transitions to apply after an object reaches an age in seconds. maxAge: number Link to this property type: "Age" Link to this property
Link to this property
R2LifecycleDateCondition object {date, type } Condition for lifecycle transitions to apply on a specific date. date: string formatdate-time Link to this property type: "Date" Link to this property
Link to this property
Link to this property storageClass: "InfrequentAccess" Link to this property
Link to this property
Link to this property
[Link to this property](<#(resource)%20r2.buckets.lifecycle%20%3E%20(model)%20lifecycle_get_response%20%3E%20(schema)>) LifecycleUpdateResponse = unknown [Link to this property](<#(resource)%20r2.buckets.lifecycle%20%3E%20(model)%20lifecycle_update_response%20%3E%20(schema)>) #### R2BucketsCORS ##### [Get Bucket CORS Policy](https://developers.cloudflare.com/api/resources/r2/subresources/buckets/subresources/cors/methods/get) GET/accounts/{account\_id}/r2/buckets/{bucket\_name}/cors ##### [Set Bucket CORS Policy](https://developers.cloudflare.com/api/resources/r2/subresources/buckets/subresources/cors/methods/update) PUT/accounts/{account\_id}/r2/buckets/{bucket\_name}/cors ##### [Delete Bucket CORS Policy](https://developers.cloudflare.com/api/resources/r2/subresources/buckets/subresources/cors/methods/delete) DELETE/accounts/{account\_id}/r2/buckets/{bucket\_name}/cors ##### ModelsExpand Collapse
CORSGetResponse object {rules }
rules: optional array of object {allowed, id, exposeHeaders, maxAgeSeconds }
allowed: object {methods, origins, headers } Object specifying allowed origins, methods and headers for this CORS rule.
methods: array of "GET"or "PUT"or "POST"or 2 more Specifies the value for the Access-Control-Allow-Methods header R2 sets when requesting objects in a bucket from a browser. One of the following: "GET" Link to this property "PUT" Link to this property "POST" Link to this property "DELETE" Link to this property "HEAD" Link to this property
Link to this property origins: array of string Specifies the value for the Access-Control-Allow-Origin header R2 sets when requesting objects in a bucket from a browser. Link to this property headers: optional array of string Specifies the value for the Access-Control-Allow-Headers header R2 sets when requesting objects in this bucket from a browser. Cross-origin requests that include custom headers (e.g. x-user-id) should specify these headers as AllowedHeaders. Link to this property
Link to this property id: optional string Identifier for this rule. Link to this property exposeHeaders: optional array of string Specifies the headers that can be exposed back, and accessed by, the JavaScript making the cross-origin request. If you need to access headers beyond the safelisted response headers, such as Content-Encoding or cf-cache-status, you must specify it here. Link to this property maxAgeSeconds: optional number Specifies the amount of time (in seconds) browsers are allowed to cache CORS preflight responses. Browsers may limit this to 2 hours or less, even if the maximum value (86400) is specified. Link to this property
Link to this property
[Link to this property](<#(resource)%20r2.buckets.cors%20%3E%20(model)%20cors_get_response%20%3E%20(schema)>) CORSUpdateResponse = unknown [Link to this property](<#(resource)%20r2.buckets.cors%20%3E%20(model)%20cors_update_response%20%3E%20(schema)>) CORSDeleteResponse = unknown [Link to this property](<#(resource)%20r2.buckets.cors%20%3E%20(model)%20cors_delete_response%20%3E%20(schema)>) #### R2BucketsDomains #### R2BucketsDomainsCustom ##### [List Custom Domains of Bucket](https://developers.cloudflare.com/api/resources/r2/subresources/buckets/subresources/domains/subresources/custom/methods/list) GET/accounts/{account\_id}/r2/buckets/{bucket\_name}/domains/custom ##### [Get Custom Domain Settings](https://developers.cloudflare.com/api/resources/r2/subresources/buckets/subresources/domains/subresources/custom/methods/get) GET/accounts/{account\_id}/r2/buckets/{bucket\_name}/domains/custom/{domain} ##### [Attach Custom Domain To Bucket](https://developers.cloudflare.com/api/resources/r2/subresources/buckets/subresources/domains/subresources/custom/methods/create) POST/accounts/{account\_id}/r2/buckets/{bucket\_name}/domains/custom ##### [Configure Custom Domain Settings](https://developers.cloudflare.com/api/resources/r2/subresources/buckets/subresources/domains/subresources/custom/methods/update) PUT/accounts/{account\_id}/r2/buckets/{bucket\_name}/domains/custom/{domain} ##### [Remove Custom Domain From Bucket](https://developers.cloudflare.com/api/resources/r2/subresources/buckets/subresources/domains/subresources/custom/methods/delete) DELETE/accounts/{account\_id}/r2/buckets/{bucket\_name}/domains/custom/{domain} ##### ModelsExpand Collapse
CustomListResponse object {domains }
domains: array of object {domain, enabled, status, 4 more } domain: string Domain name of the custom domain to be added. Link to this property enabled: boolean Whether this bucket is publicly accessible at the specified custom domain. Link to this property
status: object {ownership, ssl }
ownership: "pending"or "active"or "deactivated"or 3 more Ownership status of the domain. One of the following: "pending" Link to this property "active" Link to this property "deactivated" Link to this property "blocked" Link to this property "error" Link to this property "unknown" Link to this property
Link to this property
ssl: "initializing"or "pending"or "active"or 3 more SSL certificate status. One of the following: "initializing" Link to this property "pending" Link to this property "active" Link to this property "deactivated" Link to this property "error" Link to this property "unknown" Link to this property
Link to this property
Link to this property ciphers: optional array of string An allowlist of ciphers for TLS termination. These ciphers must be in the BoringSSL format. Link to this property
minTLS: optional "1.0"or "1.1"or "1.2"or "1.3" Minimum TLS Version the custom domain will accept for incoming connections. If not set, defaults to 1.0. One of the following: "1.0" Link to this property "1.1" Link to this property "1.2" Link to this property "1.3" Link to this property
Link to this property zoneId: optional string Zone ID of the custom domain resides in. Link to this property zoneName: optional string Zone that the custom domain resides in. Link to this property
Link to this property
[Link to this property](<#(resource)%20r2.buckets.domains.custom%20%3E%20(model)%20custom_list_response%20%3E%20(schema)>)
CustomGetResponse object {domain, enabled, status, 4 more } domain: string Domain name of the custom domain to be added. Link to this property enabled: boolean Whether this bucket is publicly accessible at the specified custom domain. Link to this property
status: object {ownership, ssl }
ownership: "pending"or "active"or "deactivated"or 3 more Ownership status of the domain. One of the following: "pending" Link to this property "active" Link to this property "deactivated" Link to this property "blocked" Link to this property "error" Link to this property "unknown" Link to this property
Link to this property
ssl: "initializing"or "pending"or "active"or 3 more SSL certificate status. One of the following: "initializing" Link to this property "pending" Link to this property "active" Link to this property "deactivated" Link to this property "error" Link to this property "unknown" Link to this property
Link to this property
Link to this property ciphers: optional array of string An allowlist of ciphers for TLS termination. These ciphers must be in the BoringSSL format. Link to this property
minTLS: optional "1.0"or "1.1"or "1.2"or "1.3" Minimum TLS Version the custom domain will accept for incoming connections. If not set, defaults to 1.0. One of the following: "1.0" Link to this property "1.1" Link to this property "1.2" Link to this property "1.3" Link to this property
Link to this property zoneId: optional string Zone ID of the custom domain resides in. Link to this property zoneName: optional string Zone that the custom domain resides in. Link to this property
[Link to this property](<#(resource)%20r2.buckets.domains.custom%20%3E%20(model)%20custom_get_response%20%3E%20(schema)>)
CustomCreateResponse object {domain, enabled, zoneId, 2 more } domain: string Domain name of the affected custom domain. Link to this property enabled: boolean Whether this bucket is publicly accessible at the specified custom domain. Link to this property zoneId: string Zone ID of the custom domain. Link to this property ciphers: optional array of string An allowlist of ciphers for TLS termination. These ciphers must be in the BoringSSL format. Link to this property
minTLS: optional "1.0"or "1.1"or "1.2"or "1.3" Minimum TLS Version the custom domain will accept for incoming connections. If not set, defaults to 1.0. One of the following: "1.0" Link to this property "1.1" Link to this property "1.2" Link to this property "1.3" Link to this property
Link to this property
[Link to this property](<#(resource)%20r2.buckets.domains.custom%20%3E%20(model)%20custom_create_response%20%3E%20(schema)>)
CustomUpdateResponse object {domain, ciphers, enabled, minTLS } domain: string Domain name of the affected custom domain. Link to this property ciphers: optional array of string An allowlist of ciphers for TLS termination. These ciphers must be in the BoringSSL format. Link to this property enabled: optional boolean Whether this bucket is publicly accessible at the specified custom domain. Link to this property
minTLS: optional "1.0"or "1.1"or "1.2"or "1.3" Minimum TLS Version the custom domain will accept for incoming connections. If not set, defaults to 1.0. One of the following: "1.0" Link to this property "1.1" Link to this property "1.2" Link to this property "1.3" Link to this property
Link to this property
[Link to this property](<#(resource)%20r2.buckets.domains.custom%20%3E%20(model)%20custom_update_response%20%3E%20(schema)>)
CustomDeleteResponse object {domain } domain: string Name of the removed custom domain. Link to this property
[Link to this property](<#(resource)%20r2.buckets.domains.custom%20%3E%20(model)%20custom_delete_response%20%3E%20(schema)>) #### R2BucketsDomainsManaged ##### [Get r2.dev Domain of Bucket](https://developers.cloudflare.com/api/resources/r2/subresources/buckets/subresources/domains/subresources/managed/methods/list) GET/accounts/{account\_id}/r2/buckets/{bucket\_name}/domains/managed ##### [Update r2.dev Domain of Bucket](https://developers.cloudflare.com/api/resources/r2/subresources/buckets/subresources/domains/subresources/managed/methods/update) PUT/accounts/{account\_id}/r2/buckets/{bucket\_name}/domains/managed ##### ModelsExpand Collapse
ManagedListResponse object {bucketId, domain, enabled } bucketId: string Bucket ID. maxLength32 Link to this property domain: string Domain name of the bucket’s r2.dev domain. Link to this property enabled: boolean Whether this bucket is publicly accessible at the r2.dev domain. Link to this property
[Link to this property](<#(resource)%20r2.buckets.domains.managed%20%3E%20(model)%20managed_list_response%20%3E%20(schema)>)
ManagedUpdateResponse object {bucketId, domain, enabled } bucketId: string Bucket ID. maxLength32 Link to this property domain: string Domain name of the bucket’s r2.dev domain. Link to this property enabled: boolean Whether this bucket is publicly accessible at the r2.dev domain. Link to this property
[Link to this property](<#(resource)%20r2.buckets.domains.managed%20%3E%20(model)%20managed_update_response%20%3E%20(schema)>) #### R2BucketsEvent Notifications ##### [List Event Notification Rules](https://developers.cloudflare.com/api/resources/r2/subresources/buckets/subresources/event_notifications/methods/list) GET/accounts/{account\_id}/event\_notifications/r2/{bucket\_name}/configuration ##### [Get Event Notification Rules for a Queue](https://developers.cloudflare.com/api/resources/r2/subresources/buckets/subresources/event_notifications/methods/get) GET/accounts/{account\_id}/event\_notifications/r2/{bucket\_name}/configuration/queues/{queue\_id} ##### [Create Event Notification Rules](https://developers.cloudflare.com/api/resources/r2/subresources/buckets/subresources/event_notifications/methods/update) PUT/accounts/{account\_id}/event\_notifications/r2/{bucket\_name}/configuration/queues/{queue\_id} ##### [Delete Event Notification Rules](https://developers.cloudflare.com/api/resources/r2/subresources/buckets/subresources/event_notifications/methods/delete) DELETE/accounts/{account\_id}/event\_notifications/r2/{bucket\_name}/configuration/queues/{queue\_id} ##### ModelsExpand Collapse
EventNotificationListResponse object {bucketName, queues } bucketName: optional string Name of the bucket. Link to this property
queues: optional array of object {queueId, queueName, rules } List of queues associated with the bucket. queueId: optional string Queue ID. Link to this property queueName: optional string Name of the queue. Link to this property
rules: optional array of object {actions, createdAt, description, 3 more }
actions: array of "PutObject"or "CopyObject"or "DeleteObject"or 2 more Array of R2 object actions that will trigger notifications. One of the following: "PutObject" Link to this property "CopyObject" Link to this property "DeleteObject" Link to this property "CompleteMultipartUpload" Link to this property "LifecycleDeletion" Link to this property
Link to this property createdAt: optional string Timestamp when the rule was created. Link to this property description: optional string A description that can be used to identify the event notification rule after creation. Link to this property prefix: optional string Notifications will be sent only for objects with this prefix. Link to this property ruleId: optional string Rule ID. Link to this property suffix: optional string Notifications will be sent only for objects with this suffix. Link to this property
Link to this property
Link to this property
[Link to this property](<#(resource)%20r2.buckets.event_notifications%20%3E%20(model)%20event_notification_list_response%20%3E%20(schema)>)
EventNotificationGetResponse object {queueId, queueName, rules } queueId: optional string Queue ID. Link to this property queueName: optional string Name of the queue. Link to this property
rules: optional array of object {actions, createdAt, description, 3 more }
actions: array of "PutObject"or "CopyObject"or "DeleteObject"or 2 more Array of R2 object actions that will trigger notifications. One of the following: "PutObject" Link to this property "CopyObject" Link to this property "DeleteObject" Link to this property "CompleteMultipartUpload" Link to this property "LifecycleDeletion" Link to this property
Link to this property createdAt: optional string Timestamp when the rule was created. Link to this property description: optional string A description that can be used to identify the event notification rule after creation. Link to this property prefix: optional string Notifications will be sent only for objects with this prefix. Link to this property ruleId: optional string Rule ID. Link to this property suffix: optional string Notifications will be sent only for objects with this suffix. Link to this property
Link to this property
[Link to this property](<#(resource)%20r2.buckets.event_notifications%20%3E%20(model)%20event_notification_get_response%20%3E%20(schema)>) EventNotificationUpdateResponse = unknown [Link to this property](<#(resource)%20r2.buckets.event_notifications%20%3E%20(model)%20event_notification_update_response%20%3E%20(schema)>) EventNotificationDeleteResponse = unknown [Link to this property](<#(resource)%20r2.buckets.event_notifications%20%3E%20(model)%20event_notification_delete_response%20%3E%20(schema)>) #### R2BucketsLocks ##### [Get Bucket Lock Rules](https://developers.cloudflare.com/api/resources/r2/subresources/buckets/subresources/locks/methods/get) GET/accounts/{account\_id}/r2/buckets/{bucket\_name}/lock ##### [Set Bucket Lock Rules](https://developers.cloudflare.com/api/resources/r2/subresources/buckets/subresources/locks/methods/update) PUT/accounts/{account\_id}/r2/buckets/{bucket\_name}/lock ##### ModelsExpand Collapse
LockGetResponse object {rules }
rules: optional array of object {id, condition, enabled, prefix } id: string Unique identifier for this rule. Link to this property
condition: object {maxAgeSeconds, type } or object {date, type } or object {type } Condition to apply a lock rule to an object for how long in seconds. One of the following:
R2LockRuleAgeCondition object {maxAgeSeconds, type } Condition to apply a lock rule to an object for how long in seconds. maxAgeSeconds: number Link to this property type: "Age" Link to this property
Link to this property
R2LockRuleDateCondition object {date, type } Condition to apply a lock rule to an object until a specific date. date: string formatdate-time Link to this property type: "Date" Link to this property
Link to this property
R2LockRuleIndefiniteCondition object {type } Condition to apply a lock rule indefinitely. type: "Indefinite" Link to this property
Link to this property
Link to this property enabled: boolean Whether or not this rule is in effect. Link to this property prefix: optional string Rule will only apply to objects/uploads in the bucket that start with the given prefix, an empty prefix can be provided to scope rule to all objects/uploads. Link to this property
Link to this property
[Link to this property](<#(resource)%20r2.buckets.locks%20%3E%20(model)%20lock_get_response%20%3E%20(schema)>) LockUpdateResponse = unknown [Link to this property](<#(resource)%20r2.buckets.locks%20%3E%20(model)%20lock_update_response%20%3E%20(schema)>) #### R2BucketsMetrics ##### [Get Account-Level Metrics](https://developers.cloudflare.com/api/resources/r2/subresources/buckets/subresources/metrics/methods/list) GET/accounts/{account\_id}/r2/metrics ##### ModelsExpand Collapse
MetricListResponse object {infrequentAccess, standard } Metrics based on the class they belong to.
infrequentAccess: optional object {published, uploaded } Metrics based on what state they are in(uploaded or published).
published: optional object {metadataSize, objects, payloadSize } Metrics on number of objects/amount of storage used. metadataSize: optional number Amount of. Link to this property objects: optional number Number of objects stored. Link to this property payloadSize: optional number Amount of storage used by object data. Link to this property
Link to this property
uploaded: optional object {metadataSize, objects, payloadSize } Metrics on number of objects/amount of storage used. metadataSize: optional number Amount of. Link to this property objects: optional number Number of objects stored. Link to this property payloadSize: optional number Amount of storage used by object data. Link to this property
Link to this property
Link to this property
standard: optional object {published, uploaded } Metrics based on what state they are in(uploaded or published).
published: optional object {metadataSize, objects, payloadSize } Metrics on number of objects/amount of storage used. metadataSize: optional number Amount of. Link to this property objects: optional number Number of objects stored. Link to this property payloadSize: optional number Amount of storage used by object data. Link to this property
Link to this property
uploaded: optional object {metadataSize, objects, payloadSize } Metrics on number of objects/amount of storage used. metadataSize: optional number Amount of. Link to this property objects: optional number Number of objects stored. Link to this property payloadSize: optional number Amount of storage used by object data. Link to this property
Link to this property
Link to this property
[Link to this property](<#(resource)%20r2.buckets.metrics%20%3E%20(model)%20metric_list_response%20%3E%20(schema)>) #### R2BucketsSippy ##### [Get Sippy Configuration](https://developers.cloudflare.com/api/resources/r2/subresources/buckets/subresources/sippy/methods/get) GET/accounts/{account\_id}/r2/buckets/{bucket\_name}/sippy ##### [Enable Sippy](https://developers.cloudflare.com/api/resources/r2/subresources/buckets/subresources/sippy/methods/update) PUT/accounts/{account\_id}/r2/buckets/{bucket\_name}/sippy ##### [Disable Sippy](https://developers.cloudflare.com/api/resources/r2/subresources/buckets/subresources/sippy/methods/delete) DELETE/accounts/{account\_id}/r2/buckets/{bucket\_name}/sippy ##### ModelsExpand Collapse Provider = "r2" [Link to this property](<#(resource)%20r2.buckets.sippy%20%3E%20(model)%20provider%20%3E%20(schema)>)
Sippy object {destination, enabled, source }
destination: optional object {accessKeyId, account, bucket, provider } Details about the configured destination bucket. accessKeyId: optional string ID of the Cloudflare API token used when writing objects to this bucket. Link to this property account: optional string Link to this property bucket: optional string Name of the bucket on the provider. Link to this property provider: optional Provider Link to this property
Link to this property enabled: optional boolean State of Sippy for this bucket. Link to this property
source: optional object {bucket, bucketUrl, container, 2 more } Details about the configured source bucket. bucket: optional string Name of the bucket on the provider (AWS, GCS only). Link to this property bucketUrl: optional string S3-compatible URL (Generic S3-compatible providers only). Link to this property container: optional string Name of the Azure Blob Storage container (Azure only). Link to this property
provider: optional "aws"or "gcs"or "s3"or "azure" One of the following: "aws" Link to this property "gcs" Link to this property "s3" Link to this property "azure" Link to this property
Link to this property region: optional string Region where the bucket resides (AWS only). Link to this property
Link to this property
[Link to this property](<#(resource)%20r2.buckets.sippy%20%3E%20(model)%20sippy%20%3E%20(schema)>)
SippyDeleteResponse object {enabled } enabled: optional false Link to this property
[Link to this property](<#(resource)%20r2.buckets.sippy%20%3E%20(model)%20sippy_delete_response%20%3E%20(schema)>) #### R2BucketsObjects ##### [List Objects](https://developers.cloudflare.com/api/resources/r2/subresources/buckets/subresources/objects/methods/list) GET/accounts/{account\_id}/r2/buckets/{bucket\_name}/objects ##### [Get Object](https://developers.cloudflare.com/api/resources/r2/subresources/buckets/subresources/objects/methods/get) GET/accounts/{account\_id}/r2/buckets/{bucket\_name}/objects/{object\_key} ##### [Upload Object](https://developers.cloudflare.com/api/resources/r2/subresources/buckets/subresources/objects/methods/upload) PUT/accounts/{account\_id}/r2/buckets/{bucket\_name}/objects/{object\_key} ##### [Delete Object](https://developers.cloudflare.com/api/resources/r2/subresources/buckets/subresources/objects/methods/delete) DELETE/accounts/{account\_id}/r2/buckets/{bucket\_name}/objects/{object\_key} ##### ModelsExpand Collapse
ObjectListResponse object {custom\_metadata, etag, http\_metadata, 5 more } Metadata for an R2 object. custom\_metadata: optional map\[string] Custom metadata key-value pairs associated with the object. Link to this property etag: optional string The entity tag for the object. In JSON list/get responses this is the raw hex digest (without surrounding quotes). The HTTP ETag response header on Get Object follows RFC 7232 and IS wrapped in surrounding double-quotes. Link to this property
http\_metadata: optional object {cacheControl, cacheExpiry, contentDisposition, 3 more } HTTP metadata associated with an R2 object. cacheControl: optional string Specifies caching behavior for the object. Link to this property cacheExpiry: optional string The date and time at which the object’s cache entry expires. formatdate-time Link to this property contentDisposition: optional string Specifies presentational information for the object. Link to this property contentEncoding: optional string Specifies the content encoding applied to the object. Link to this property contentLanguage: optional string The language of the object content. Link to this property contentType: optional string The MIME type of the object. Link to this property
Link to this property key: optional string The object key (name). Link to this property last\_modified: optional string The date and time the object was last modified. formatdate-time Link to this property size: optional number The size of the object in bytes. Link to this property ssec: optional boolean Whether the object is encrypted with a customer-supplied encryption key. Link to this property
storage\_class: optional "Standard"or "InfrequentAccess" Storage class for newly uploaded objects, unless specified otherwise. One of the following: "Standard" Link to this property "InfrequentAccess" Link to this property
Link to this property
[Link to this property](<#(resource)%20r2.buckets.objects%20%3E%20(model)%20object_list_response%20%3E%20(schema)>)
ObjectUploadResponse object {etag, key, size, 3 more } Result of a successful object upload. etag: optional string The entity tag for the uploaded object. Link to this property key: optional string The key (name) of the uploaded object. Link to this property size: optional string The size of the uploaded object in bytes (as a string). Link to this property
storage\_class: optional "Standard"or "InfrequentAccess" Storage class for newly uploaded objects, unless specified otherwise. One of the following: "Standard" Link to this property "InfrequentAccess" Link to this property
Link to this property uploaded: optional string The date and time the object was uploaded. formatdate-time Link to this property version: optional string The version UUID of the uploaded object. Link to this property
[Link to this property](<#(resource)%20r2.buckets.objects%20%3E%20(model)%20object_upload_response%20%3E%20(schema)>)
ObjectDeleteResponse object {key } Result of a successful object deletion. key: optional string The key (name) of the deleted object. Link to this property
[Link to this property](<#(resource)%20r2.buckets.objects%20%3E%20(model)%20object_delete_response%20%3E%20(schema)>) #### R2Temporary Credentials ##### [Create Temporary Access Credentials](https://developers.cloudflare.com/api/resources/r2/subresources/temporary_credentials/methods/create) POST/accounts/{account\_id}/r2/temp-access-credentials ##### ModelsExpand Collapse
TemporaryCredential object {bucket, parentAccessKeyId, permission, 3 more } bucket: string Name of the R2 bucket. Link to this property parentAccessKeyId: string Access key ID of the parent R2 API token. The temporary credentials cannot exceed this token’s permissions. Link to this property
permission: "admin-read-write"or "admin-read-only"or "object-read-write"or "object-read-only" Permissions allowed on the credentials. One of the following: "admin-read-write" Link to this property "admin-read-only" Link to this property "object-read-write" Link to this property "object-read-only" Link to this property
Link to this property ttlSeconds: number Lifetime of the temporary credentials in seconds, up to 604800 seconds (7 days). maximum604800 Link to this property objects: optional array of string Optional object paths to scope the credentials to. Link to this property prefixes: optional array of string Optional prefix paths to scope the credentials to. Link to this property
[Link to this property](<#(resource)%20r2.temporary_credentials%20%3E%20(model)%20temporary_credential%20%3E%20(schema)>)
TemporaryCredentialCreateResponse object {accessKeyId, secretAccessKey, sessionToken } accessKeyId: optional string ID for new access key. Link to this property secretAccessKey: optional string Secret access key. Link to this property sessionToken: optional string Security token. Link to this property
[Link to this property](<#(resource)%20r2.temporary_credentials%20%3E%20(model)%20temporary_credential_create_response%20%3E%20(schema)>) #### R2Super Slurper #### R2Super SlurperJobs ##### [List jobs](https://developers.cloudflare.com/api/resources/r2/subresources/super_slurper/subresources/jobs/methods/list) GET/accounts/{account\_id}/slurper/jobs ##### [Get job details](https://developers.cloudflare.com/api/resources/r2/subresources/super_slurper/subresources/jobs/methods/get) GET/accounts/{account\_id}/slurper/jobs/{job\_id} ##### [Create a job](https://developers.cloudflare.com/api/resources/r2/subresources/super_slurper/subresources/jobs/methods/create) POST/accounts/{account\_id}/slurper/jobs ##### [Abort all jobs](https://developers.cloudflare.com/api/resources/r2/subresources/super_slurper/subresources/jobs/methods/abort_all) PUT/accounts/{account\_id}/slurper/jobs/abortAll ##### [Abort a job](https://developers.cloudflare.com/api/resources/r2/subresources/super_slurper/subresources/jobs/methods/abort) PUT/accounts/{account\_id}/slurper/jobs/{job\_id}/abort ##### [Pause a job](https://developers.cloudflare.com/api/resources/r2/subresources/super_slurper/subresources/jobs/methods/pause) PUT/accounts/{account\_id}/slurper/jobs/{job\_id}/pause ##### [Get job progress](https://developers.cloudflare.com/api/resources/r2/subresources/super_slurper/subresources/jobs/methods/progress) GET/accounts/{account\_id}/slurper/jobs/{job\_id}/progress ##### [Resume a job](https://developers.cloudflare.com/api/resources/r2/subresources/super_slurper/subresources/jobs/methods/resume) PUT/accounts/{account\_id}/slurper/jobs/{job\_id}/resume ##### ModelsExpand Collapse
JobListResponse object {id, createdAt, finishedAt, 4 more } id: optional string Link to this property createdAt: optional string Link to this property finishedAt: optional string Link to this property overwrite: optional boolean Link to this property
source: optional object {bucket, endpoint, keys, 2 more } or object {bucket, keys, pathPrefix, vendor } or object {bucket, jurisdiction, keys, 2 more } One of the following:
S3SourceResponseSchema object {bucket, endpoint, keys, 2 more } bucket: optional string Link to this property endpoint: optional string formaturi Link to this property keys: optional array of string Link to this property pathPrefix: optional string Link to this property vendor: optional "s3" Link to this property
Link to this property
GcsSourceResponseSchema object {bucket, keys, pathPrefix, vendor } bucket: optional string Link to this property keys: optional array of string Link to this property pathPrefix: optional string Link to this property vendor: optional "gcs" Link to this property
Link to this property
R2SourceResponseSchema object {bucket, jurisdiction, keys, 2 more } bucket: optional string Link to this property
jurisdiction: optional "default"or "eu"or "us"or "fedramp" One of the following: "default" Link to this property "eu" Link to this property "us" Link to this property "fedramp" Link to this property
Link to this property keys: optional array of string Link to this property pathPrefix: optional string Link to this property vendor: optional Provider Link to this property
Link to this property
Link to this property
status: optional "running"or "paused"or "aborted"or "completed" One of the following: "running" Link to this property "paused" Link to this property "aborted" Link to this property "completed" Link to this property
Link to this property
target: optional object {bucket, jurisdiction, vendor } bucket: optional string Link to this property
jurisdiction: optional "default"or "eu"or "us"or "fedramp" One of the following: "default" Link to this property "eu" Link to this property "us" Link to this property "fedramp" Link to this property
Link to this property vendor: optional Provider Link to this property
Link to this property
[Link to this property](<#(resource)%20r2.super_slurper.jobs%20%3E%20(model)%20job_list_response%20%3E%20(schema)>)
JobGetResponse object {id, createdAt, finishedAt, 4 more } id: optional string Link to this property createdAt: optional string Link to this property finishedAt: optional string Link to this property overwrite: optional boolean Link to this property
source: optional object {bucket, endpoint, keys, 2 more } or object {bucket, keys, pathPrefix, vendor } or object {bucket, jurisdiction, keys, 2 more } One of the following:
S3SourceResponseSchema object {bucket, endpoint, keys, 2 more } bucket: optional string Link to this property endpoint: optional string formaturi Link to this property keys: optional array of string Link to this property pathPrefix: optional string Link to this property vendor: optional "s3" Link to this property
Link to this property
GcsSourceResponseSchema object {bucket, keys, pathPrefix, vendor } bucket: optional string Link to this property keys: optional array of string Link to this property pathPrefix: optional string Link to this property vendor: optional "gcs" Link to this property
Link to this property
R2SourceResponseSchema object {bucket, jurisdiction, keys, 2 more } bucket: optional string Link to this property
jurisdiction: optional "default"or "eu"or "us"or "fedramp" One of the following: "default" Link to this property "eu" Link to this property "us" Link to this property "fedramp" Link to this property
Link to this property keys: optional array of string Link to this property pathPrefix: optional string Link to this property vendor: optional Provider Link to this property
Link to this property
Link to this property
status: optional "running"or "paused"or "aborted"or "completed" One of the following: "running" Link to this property "paused" Link to this property "aborted" Link to this property "completed" Link to this property
Link to this property
target: optional object {bucket, jurisdiction, vendor } bucket: optional string Link to this property
jurisdiction: optional "default"or "eu"or "us"or "fedramp" One of the following: "default" Link to this property "eu" Link to this property "us" Link to this property "fedramp" Link to this property
Link to this property vendor: optional Provider Link to this property
Link to this property
[Link to this property](<#(resource)%20r2.super_slurper.jobs%20%3E%20(model)%20job_get_response%20%3E%20(schema)>)
JobCreateResponse object {id } id: optional string Link to this property
[Link to this property](<#(resource)%20r2.super_slurper.jobs%20%3E%20(model)%20job_create_response%20%3E%20(schema)>) JobAbortAllResponse = string [Link to this property](<#(resource)%20r2.super_slurper.jobs%20%3E%20(model)%20job_abort_all_response%20%3E%20(schema)>) JobAbortResponse = string [Link to this property](<#(resource)%20r2.super_slurper.jobs%20%3E%20(model)%20job_abort_response%20%3E%20(schema)>) JobPauseResponse = string [Link to this property](<#(resource)%20r2.super_slurper.jobs%20%3E%20(model)%20job_pause_response%20%3E%20(schema)>)
JobProgressResponse object {id, createdAt, failedObjects, 4 more } id: optional string Link to this property createdAt: optional string Link to this property failedObjects: optional number Link to this property objects: optional number Link to this property skippedObjects: optional number Link to this property
status: optional "running"or "paused"or "aborted"or "completed" One of the following: "running" Link to this property "paused" Link to this property "aborted" Link to this property "completed" Link to this property
Link to this property transferredObjects: optional number Link to this property
[Link to this property](<#(resource)%20r2.super_slurper.jobs%20%3E%20(model)%20job_progress_response%20%3E%20(schema)>) JobResumeResponse = string [Link to this property](<#(resource)%20r2.super_slurper.jobs%20%3E%20(model)%20job_resume_response%20%3E%20(schema)>) #### R2Super SlurperJobsLogs ##### [Get job logs](https://developers.cloudflare.com/api/resources/r2/subresources/super_slurper/subresources/jobs/subresources/logs/methods/list) GET/accounts/{account\_id}/slurper/jobs/{job\_id}/logs ##### ModelsExpand Collapse
LogListResponse object {createdAt, job, logType, 2 more } createdAt: optional string Link to this property job: optional string Link to this property
logType: optional "migrationStart"or "migrationComplete"or "migrationAbort"or 12 more One of the following: "migrationStart" Link to this property "migrationComplete" Link to this property "migrationAbort" Link to this property "migrationError" Link to this property "migrationPause" Link to this property "migrationResume" Link to this property "migrationErrorFailedContinuation" Link to this property "importErrorRetryExhaustion" Link to this property "importSkippedStorageClass" Link to this property "importSkippedOversized" Link to this property "importSkippedEmptyObject" Link to this property "importSkippedUnsupportedContentType" Link to this property "importSkippedExcludedContentType" Link to this property "importSkippedInvalidMedia" Link to this property "importSkippedRequiresRetrieval" Link to this property
Link to this property message: optional string Link to this property objectKey: optional string Link to this property
[Link to this property](<#(resource)%20r2.super_slurper.jobs.logs%20%3E%20(model)%20log_list_response%20%3E%20(schema)>) #### R2Super SlurperConnectivity Precheck ##### [Check source connectivity](https://developers.cloudflare.com/api/resources/r2/subresources/super_slurper/subresources/connectivity_precheck/methods/source) PUT/accounts/{account\_id}/slurper/source/connectivity-precheck ##### [Check target connectivity](https://developers.cloudflare.com/api/resources/r2/subresources/super_slurper/subresources/connectivity_precheck/methods/target) PUT/accounts/{account\_id}/slurper/target/connectivity-precheck ##### ModelsExpand Collapse
ConnectivityPrecheckSourceResponse object {connectivityStatus }
connectivityStatus: optional "success"or "error" One of the following: "success" Link to this property "error" Link to this property
Link to this property
[Link to this property](<#(resource)%20r2.super_slurper.connectivity_precheck%20%3E%20(model)%20connectivity_precheck_source_response%20%3E%20(schema)>)
ConnectivityPrecheckTargetResponse object {connectivityStatus }
connectivityStatus: optional "success"or "error" One of the following: "success" Link to this property "error" Link to this property
Link to this property
[Link to this property](<#(resource)%20r2.super_slurper.connectivity_precheck%20%3E%20(model)%20connectivity_precheck_target_response%20%3E%20(schema)>)