--- title: Buckets --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/python) [R2](https://developers.cloudflare.com/api/python/resources/r2) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Buckets ##### [List Buckets](https://developers.cloudflare.com/api/python/resources/r2/subresources/buckets/methods/list) r2.buckets.list(BucketListParams\*\*kwargs) -> [BucketListResponse]() GET/accounts/{account\_id}/r2/buckets ##### [Get Bucket](https://developers.cloudflare.com/api/python/resources/r2/subresources/buckets/methods/get) r2.buckets.get(strbucket\_name, BucketGetParams\*\*kwargs) -> [Bucket]() GET/accounts/{account\_id}/r2/buckets/{bucket\_name} ##### [Create Bucket](https://developers.cloudflare.com/api/python/resources/r2/subresources/buckets/methods/create) r2.buckets.create(BucketCreateParams\*\*kwargs) -> [Bucket]() POST/accounts/{account\_id}/r2/buckets ##### [Patch Bucket](https://developers.cloudflare.com/api/python/resources/r2/subresources/buckets/methods/edit) r2.buckets.edit(strbucket\_name, BucketEditParams\*\*kwargs) -> [Bucket]() PATCH/accounts/{account\_id}/r2/buckets/{bucket\_name} ##### [Delete Bucket](https://developers.cloudflare.com/api/python/resources/r2/subresources/buckets/methods/delete) r2.buckets.delete(strbucket\_name, BucketDeleteParams\*\*kwargs) -> object DELETE/accounts/{account\_id}/r2/buckets/{bucket\_name} ##### ModelsExpand Collapse
class Bucket: … A single R2 bucket. creation\_date: Optional\[str] Creation timestamp. Link to this property
jurisdiction: Optional\[Literal\["default", "eu", "us", 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\[Literal\["apac", "eeur", "enam", 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\[str] Name of the bucket. maxLength64 minLength3 Link to this property
storage\_class: Optional\[Literal\["Standard", "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)>)
class BucketListResponse: …
buckets: Optional\[List\[Bucket]] creation\_date: Optional\[str] Creation timestamp. Link to this property
jurisdiction: Optional\[Literal\["default", "eu", "us", 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\[Literal\["apac", "eeur", "enam", 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\[str] Name of the bucket. maxLength64 minLength3 Link to this property
storage\_class: Optional\[Literal\["Standard", "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)>) #### BucketsLifecycle ##### [Get Object Lifecycle Rules](https://developers.cloudflare.com/api/python/resources/r2/subresources/buckets/subresources/lifecycle/methods/get) r2.buckets.lifecycle.get(strbucket\_name, LifecycleGetParams\*\*kwargs) -> [LifecycleGetResponse]() GET/accounts/{account\_id}/r2/buckets/{bucket\_name}/lifecycle ##### [Set Object Lifecycle Rules](https://developers.cloudflare.com/api/python/resources/r2/subresources/buckets/subresources/lifecycle/methods/update) r2.buckets.lifecycle.update(strbucket\_name, LifecycleUpdateParams\*\*kwargs) -> object PUT/accounts/{account\_id}/r2/buckets/{bucket\_name}/lifecycle ##### ModelsExpand Collapse
class LifecycleGetResponse: …
rules: Optional\[List\[Rule]] id: str Unique identifier for this rule. Link to this property
conditions: RuleConditions Conditions that apply to all transitions of this rule. prefix: str 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: bool Whether or not this rule is in effect. Link to this property
abort\_multipart\_uploads\_transition: Optional\[RuleAbortMultipartUploadsTransition] Transition to abort ongoing multipart uploads.
condition: Optional\[RuleAbortMultipartUploadsTransitionCondition] Condition for lifecycle transitions to apply after an object reaches an age in seconds. max\_age: int Link to this property type: Literal\["Age"] Link to this property
Link to this property
Link to this property
delete\_objects\_transition: Optional\[RuleDeleteObjectsTransition] Transition to delete objects.
condition: Optional\[RuleDeleteObjectsTransitionCondition] Condition for lifecycle transitions to apply after an object reaches an age in seconds. One of the following:
class RuleDeleteObjectsTransitionConditionR2LifecycleAgeCondition: … Condition for lifecycle transitions to apply after an object reaches an age in seconds. max\_age: int Link to this property type: Literal\["Age"] Link to this property
Link to this property
class RuleDeleteObjectsTransitionConditionR2LifecycleDateCondition: … Condition for lifecycle transitions to apply on a specific date. date: datetime formatdate-time Link to this property type: Literal\["Date"] Link to this property
Link to this property
Link to this property
Link to this property
storage\_class\_transitions: Optional\[List\[RuleStorageClassTransition]] Transitions to change the storage class of objects.
condition: RuleStorageClassTransitionCondition Condition for lifecycle transitions to apply after an object reaches an age in seconds. One of the following:
class RuleStorageClassTransitionConditionR2LifecycleAgeCondition: … Condition for lifecycle transitions to apply after an object reaches an age in seconds. max\_age: int Link to this property type: Literal\["Age"] Link to this property
Link to this property
class RuleStorageClassTransitionConditionR2LifecycleDateCondition: … Condition for lifecycle transitions to apply on a specific date. date: datetime formatdate-time Link to this property type: Literal\["Date"] Link to this property
Link to this property
Link to this property storage\_class: Literal\["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)>) #### BucketsCORS ##### [Get Bucket CORS Policy](https://developers.cloudflare.com/api/python/resources/r2/subresources/buckets/subresources/cors/methods/get) r2.buckets.cors.get(strbucket\_name, CORSGetParams\*\*kwargs) -> [CORSGetResponse]() GET/accounts/{account\_id}/r2/buckets/{bucket\_name}/cors ##### [Set Bucket CORS Policy](https://developers.cloudflare.com/api/python/resources/r2/subresources/buckets/subresources/cors/methods/update) r2.buckets.cors.update(strbucket\_name, CORSUpdateParams\*\*kwargs) -> object PUT/accounts/{account\_id}/r2/buckets/{bucket\_name}/cors ##### [Delete Bucket CORS Policy](https://developers.cloudflare.com/api/python/resources/r2/subresources/buckets/subresources/cors/methods/delete) r2.buckets.cors.delete(strbucket\_name, CORSDeleteParams\*\*kwargs) -> object DELETE/accounts/{account\_id}/r2/buckets/{bucket\_name}/cors ##### ModelsExpand Collapse
class CORSGetResponse: …
rules: Optional\[List\[Rule]]
allowed: RuleAllowed Object specifying allowed origins, methods and headers for this CORS rule.
methods: List\[Literal\["GET", "PUT", "POST", 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: List\[str] 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\[List\[str]] 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\[str] Identifier for this rule. Link to this property expose\_headers: Optional\[List\[str]] 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 max\_age\_seconds: Optional\[float] 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)>) #### BucketsDomains #### BucketsDomainsCustom ##### [List Custom Domains of Bucket](https://developers.cloudflare.com/api/python/resources/r2/subresources/buckets/subresources/domains/subresources/custom/methods/list) r2.buckets.domains.custom.list(strbucket\_name, CustomListParams\*\*kwargs) -> [CustomListResponse]() GET/accounts/{account\_id}/r2/buckets/{bucket\_name}/domains/custom ##### [Get Custom Domain Settings](https://developers.cloudflare.com/api/python/resources/r2/subresources/buckets/subresources/domains/subresources/custom/methods/get) r2.buckets.domains.custom.get(strdomain, CustomGetParams\*\*kwargs) -> [CustomGetResponse]() GET/accounts/{account\_id}/r2/buckets/{bucket\_name}/domains/custom/{domain} ##### [Attach Custom Domain To Bucket](https://developers.cloudflare.com/api/python/resources/r2/subresources/buckets/subresources/domains/subresources/custom/methods/create) r2.buckets.domains.custom.create(strbucket\_name, CustomCreateParams\*\*kwargs) -> [CustomCreateResponse]() POST/accounts/{account\_id}/r2/buckets/{bucket\_name}/domains/custom ##### [Configure Custom Domain Settings](https://developers.cloudflare.com/api/python/resources/r2/subresources/buckets/subresources/domains/subresources/custom/methods/update) r2.buckets.domains.custom.update(strdomain, CustomUpdateParams\*\*kwargs) -> [CustomUpdateResponse]() PUT/accounts/{account\_id}/r2/buckets/{bucket\_name}/domains/custom/{domain} ##### [Remove Custom Domain From Bucket](https://developers.cloudflare.com/api/python/resources/r2/subresources/buckets/subresources/domains/subresources/custom/methods/delete) r2.buckets.domains.custom.delete(strdomain, CustomDeleteParams\*\*kwargs) -> [CustomDeleteResponse]() DELETE/accounts/{account\_id}/r2/buckets/{bucket\_name}/domains/custom/{domain} ##### ModelsExpand Collapse
class CustomListResponse: …
domains: List\[Domain] domain: str Domain name of the custom domain to be added. Link to this property enabled: bool Whether this bucket is publicly accessible at the specified custom domain. Link to this property
status: DomainStatus
ownership: Literal\["pending", "active", "deactivated", 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: Literal\["initializing", "pending", "active", 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\[List\[str]] An allowlist of ciphers for TLS termination. These ciphers must be in the BoringSSL format. Link to this property
min\_tls: Optional\[Literal\["1.0", "1.1", "1.2", "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 zone\_id: Optional\[str] Zone ID of the custom domain resides in. Link to this property zone\_name: Optional\[str] 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)>)
class CustomGetResponse: … domain: str Domain name of the custom domain to be added. Link to this property enabled: bool Whether this bucket is publicly accessible at the specified custom domain. Link to this property
status: Status
ownership: Literal\["pending", "active", "deactivated", 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: Literal\["initializing", "pending", "active", 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\[List\[str]] An allowlist of ciphers for TLS termination. These ciphers must be in the BoringSSL format. Link to this property
min\_tls: Optional\[Literal\["1.0", "1.1", "1.2", "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 zone\_id: Optional\[str] Zone ID of the custom domain resides in. Link to this property zone\_name: Optional\[str] 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)>)
class CustomCreateResponse: … domain: str Domain name of the affected custom domain. Link to this property enabled: bool Whether this bucket is publicly accessible at the specified custom domain. Link to this property zone\_id: str Zone ID of the custom domain. Link to this property ciphers: Optional\[List\[str]] An allowlist of ciphers for TLS termination. These ciphers must be in the BoringSSL format. Link to this property
min\_tls: Optional\[Literal\["1.0", "1.1", "1.2", "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)>)
class CustomUpdateResponse: … domain: str Domain name of the affected custom domain. Link to this property ciphers: Optional\[List\[str]] An allowlist of ciphers for TLS termination. These ciphers must be in the BoringSSL format. Link to this property enabled: Optional\[bool] Whether this bucket is publicly accessible at the specified custom domain. Link to this property
min\_tls: Optional\[Literal\["1.0", "1.1", "1.2", "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)>)
class CustomDeleteResponse: … domain: str 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)>) #### BucketsDomainsManaged ##### [Get r2.dev Domain of Bucket](https://developers.cloudflare.com/api/python/resources/r2/subresources/buckets/subresources/domains/subresources/managed/methods/list) r2.buckets.domains.managed.list(strbucket\_name, ManagedListParams\*\*kwargs) -> [ManagedListResponse]() GET/accounts/{account\_id}/r2/buckets/{bucket\_name}/domains/managed ##### [Update r2.dev Domain of Bucket](https://developers.cloudflare.com/api/python/resources/r2/subresources/buckets/subresources/domains/subresources/managed/methods/update) r2.buckets.domains.managed.update(strbucket\_name, ManagedUpdateParams\*\*kwargs) -> [ManagedUpdateResponse]() PUT/accounts/{account\_id}/r2/buckets/{bucket\_name}/domains/managed ##### ModelsExpand Collapse
class ManagedListResponse: … bucket\_id: str Bucket ID. maxLength32 Link to this property domain: str Domain name of the bucket’s r2.dev domain. Link to this property enabled: bool 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)>)
class ManagedUpdateResponse: … bucket\_id: str Bucket ID. maxLength32 Link to this property domain: str Domain name of the bucket’s r2.dev domain. Link to this property enabled: bool 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)>) #### BucketsEvent Notifications ##### [List Event Notification Rules](https://developers.cloudflare.com/api/python/resources/r2/subresources/buckets/subresources/event_notifications/methods/list) r2.buckets.event\_notifications.list(strbucket\_name, EventNotificationListParams\*\*kwargs) -> [EventNotificationListResponse]() GET/accounts/{account\_id}/event\_notifications/r2/{bucket\_name}/configuration ##### [Get Event Notification Rules for a Queue](https://developers.cloudflare.com/api/python/resources/r2/subresources/buckets/subresources/event_notifications/methods/get) r2.buckets.event\_notifications.get(strqueue\_id, EventNotificationGetParams\*\*kwargs) -> [EventNotificationGetResponse]() GET/accounts/{account\_id}/event\_notifications/r2/{bucket\_name}/configuration/queues/{queue\_id} ##### [Create Event Notification Rules](https://developers.cloudflare.com/api/python/resources/r2/subresources/buckets/subresources/event_notifications/methods/update) r2.buckets.event\_notifications.update(strqueue\_id, EventNotificationUpdateParams\*\*kwargs) -> object PUT/accounts/{account\_id}/event\_notifications/r2/{bucket\_name}/configuration/queues/{queue\_id} ##### [Delete Event Notification Rules](https://developers.cloudflare.com/api/python/resources/r2/subresources/buckets/subresources/event_notifications/methods/delete) r2.buckets.event\_notifications.delete(strqueue\_id, EventNotificationDeleteParams\*\*kwargs) -> object DELETE/accounts/{account\_id}/event\_notifications/r2/{bucket\_name}/configuration/queues/{queue\_id} ##### ModelsExpand Collapse
class EventNotificationListResponse: … bucket\_name: Optional\[str] Name of the bucket. Link to this property
queues: Optional\[List\[Queue]] List of queues associated with the bucket. queue\_id: Optional\[str] Queue ID. Link to this property queue\_name: Optional\[str] Name of the queue. Link to this property
rules: Optional\[List\[QueueRule]]
actions: List\[Literal\["PutObject", "CopyObject", "DeleteObject", 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 created\_at: Optional\[str] Timestamp when the rule was created. Link to this property description: Optional\[str] A description that can be used to identify the event notification rule after creation. Link to this property prefix: Optional\[str] Notifications will be sent only for objects with this prefix. Link to this property rule\_id: Optional\[str] Rule ID. Link to this property suffix: Optional\[str] 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)>)
class EventNotificationGetResponse: … queue\_id: Optional\[str] Queue ID. Link to this property queue\_name: Optional\[str] Name of the queue. Link to this property
rules: Optional\[List\[Rule]]
actions: List\[Literal\["PutObject", "CopyObject", "DeleteObject", 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 created\_at: Optional\[str] Timestamp when the rule was created. Link to this property description: Optional\[str] A description that can be used to identify the event notification rule after creation. Link to this property prefix: Optional\[str] Notifications will be sent only for objects with this prefix. Link to this property rule\_id: Optional\[str] Rule ID. Link to this property suffix: Optional\[str] 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)>) #### BucketsLocks ##### [Get Bucket Lock Rules](https://developers.cloudflare.com/api/python/resources/r2/subresources/buckets/subresources/locks/methods/get) r2.buckets.locks.get(strbucket\_name, LockGetParams\*\*kwargs) -> [LockGetResponse]() GET/accounts/{account\_id}/r2/buckets/{bucket\_name}/lock ##### [Set Bucket Lock Rules](https://developers.cloudflare.com/api/python/resources/r2/subresources/buckets/subresources/locks/methods/update) r2.buckets.locks.update(strbucket\_name, LockUpdateParams\*\*kwargs) -> object PUT/accounts/{account\_id}/r2/buckets/{bucket\_name}/lock ##### ModelsExpand Collapse
class LockGetResponse: …
rules: Optional\[List\[Rule]] id: str Unique identifier for this rule. Link to this property
condition: RuleCondition Condition to apply a lock rule to an object for how long in seconds. One of the following:
class RuleConditionR2LockRuleAgeCondition: … Condition to apply a lock rule to an object for how long in seconds. max\_age\_seconds: int Link to this property type: Literal\["Age"] Link to this property
Link to this property
class RuleConditionR2LockRuleDateCondition: … Condition to apply a lock rule to an object until a specific date. date: datetime formatdate-time Link to this property type: Literal\["Date"] Link to this property
Link to this property
class RuleConditionR2LockRuleIndefiniteCondition: … Condition to apply a lock rule indefinitely. type: Literal\["Indefinite"] Link to this property
Link to this property
Link to this property enabled: bool Whether or not this rule is in effect. Link to this property prefix: Optional\[str] 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)>) #### BucketsMetrics ##### [Get Account-Level Metrics](https://developers.cloudflare.com/api/python/resources/r2/subresources/buckets/subresources/metrics/methods/list) r2.buckets.metrics.list(MetricListParams\*\*kwargs) -> [MetricListResponse]() GET/accounts/{account\_id}/r2/metrics ##### ModelsExpand Collapse
class MetricListResponse: … Metrics based on the class they belong to.
infrequent\_access: Optional\[InfrequentAccess] Metrics based on what state they are in(uploaded or published).
published: Optional\[InfrequentAccessPublished] Metrics on number of objects/amount of storage used. metadata\_size: Optional\[float] Amount of. Link to this property objects: Optional\[float] Number of objects stored. Link to this property payload\_size: Optional\[float] Amount of storage used by object data. Link to this property
Link to this property
uploaded: Optional\[InfrequentAccessUploaded] Metrics on number of objects/amount of storage used. metadata\_size: Optional\[float] Amount of. Link to this property objects: Optional\[float] Number of objects stored. Link to this property payload\_size: Optional\[float] Amount of storage used by object data. Link to this property
Link to this property
Link to this property
standard: Optional\[Standard] Metrics based on what state they are in(uploaded or published).
published: Optional\[StandardPublished] Metrics on number of objects/amount of storage used. metadata\_size: Optional\[float] Amount of. Link to this property objects: Optional\[float] Number of objects stored. Link to this property payload\_size: Optional\[float] Amount of storage used by object data. Link to this property
Link to this property
uploaded: Optional\[StandardUploaded] Metrics on number of objects/amount of storage used. metadata\_size: Optional\[float] Amount of. Link to this property objects: Optional\[float] Number of objects stored. Link to this property payload\_size: Optional\[float] 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)>) #### BucketsSippy ##### [Get Sippy Configuration](https://developers.cloudflare.com/api/python/resources/r2/subresources/buckets/subresources/sippy/methods/get) r2.buckets.sippy.get(strbucket\_name, SippyGetParams\*\*kwargs) -> [Sippy]() GET/accounts/{account\_id}/r2/buckets/{bucket\_name}/sippy ##### [Enable Sippy](https://developers.cloudflare.com/api/python/resources/r2/subresources/buckets/subresources/sippy/methods/update) r2.buckets.sippy.update(strbucket\_name, SippyUpdateParams\*\*kwargs) -> [Sippy]() PUT/accounts/{account\_id}/r2/buckets/{bucket\_name}/sippy ##### [Disable Sippy](https://developers.cloudflare.com/api/python/resources/r2/subresources/buckets/subresources/sippy/methods/delete) r2.buckets.sippy.delete(strbucket\_name, SippyDeleteParams\*\*kwargs) -> [SippyDeleteResponse]() DELETE/accounts/{account\_id}/r2/buckets/{bucket\_name}/sippy ##### ModelsExpand Collapse Literal\["r2"] [Link to this property](<#(resource)%20r2.buckets.sippy%20%3E%20(model)%20provider%20%3E%20(schema)>)
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. Link to this property account: Optional\[str] Link to this property bucket: Optional\[str] Name of the bucket on the provider. Link to this property provider: Optional\[Provider] Link to this property
Link to this property enabled: Optional\[bool] State of Sippy for this bucket. Link to this property
source: Optional\[Source] Details about the configured source bucket. bucket: Optional\[str] Name of the bucket on the provider (AWS, GCS only). Link to this property bucket\_url: Optional\[str] S3-compatible URL (Generic S3-compatible providers only). Link to this property container: Optional\[str] Name of the Azure Blob Storage container (Azure only). Link to this property
provider: Optional\[Literal\["aws", "gcs", "s3", "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\[str] 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)>)
class SippyDeleteResponse: … enabled: Optional\[Literal\[false]] Link to this property
[Link to this property](<#(resource)%20r2.buckets.sippy%20%3E%20(model)%20sippy_delete_response%20%3E%20(schema)>) #### BucketsObjects ##### [List Objects](https://developers.cloudflare.com/api/python/resources/r2/subresources/buckets/subresources/objects/methods/list) r2.buckets.objects.list(strbucket\_name, ObjectListParams\*\*kwargs) -> SyncCursorPagination\[[ObjectListResponse]()] GET/accounts/{account\_id}/r2/buckets/{bucket\_name}/objects ##### [Get Object](https://developers.cloudflare.com/api/python/resources/r2/subresources/buckets/subresources/objects/methods/get) r2.buckets.objects.get(strobject\_key, ObjectGetParams\*\*kwargs) -> BinaryResponseContent GET/accounts/{account\_id}/r2/buckets/{bucket\_name}/objects/{object\_key} ##### [Upload Object](https://developers.cloudflare.com/api/python/resources/r2/subresources/buckets/subresources/objects/methods/upload) r2.buckets.objects.upload(strobject\_key, [object]()body, ObjectUploadParams\*\*kwargs) -> [ObjectUploadResponse]() PUT/accounts/{account\_id}/r2/buckets/{bucket\_name}/objects/{object\_key} ##### [Delete Object](https://developers.cloudflare.com/api/python/resources/r2/subresources/buckets/subresources/objects/methods/delete) r2.buckets.objects.delete(strobject\_key, ObjectDeleteParams\*\*kwargs) -> [ObjectDeleteResponse]() DELETE/accounts/{account\_id}/r2/buckets/{bucket\_name}/objects/{object\_key} ##### ModelsExpand Collapse
class ObjectListResponse: … Metadata for an R2 object. custom\_metadata: Optional\[Dict\[str, str]] Custom metadata key-value pairs associated with the object. Link to this property etag: Optional\[str] 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\[HTTPMetadata] HTTP metadata associated with an R2 object. cache\_control: Optional\[str] Specifies caching behavior for the object. Link to this property cache\_expiry: Optional\[datetime] The date and time at which the object’s cache entry expires. formatdate-time Link to this property content\_disposition: Optional\[str] Specifies presentational information for the object. Link to this property content\_encoding: Optional\[str] Specifies the content encoding applied to the object. Link to this property content\_language: Optional\[str] The language of the object content. Link to this property content\_type: Optional\[str] The MIME type of the object. Link to this property
Link to this property key: Optional\[str] The object key (name). Link to this property last\_modified: Optional\[datetime] The date and time the object was last modified. formatdate-time Link to this property size: Optional\[int] The size of the object in bytes. Link to this property ssec: Optional\[bool] Whether the object is encrypted with a customer-supplied encryption key. Link to this property
storage\_class: Optional\[Literal\["Standard", "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)>)
class ObjectUploadResponse: … Result of a successful object upload. etag: Optional\[str] The entity tag for the uploaded object. Link to this property key: Optional\[str] The key (name) of the uploaded object. Link to this property size: Optional\[str] The size of the uploaded object in bytes (as a string). Link to this property
storage\_class: Optional\[Literal\["Standard", "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\[datetime] The date and time the object was uploaded. formatdate-time Link to this property version: Optional\[str] 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)>)
class ObjectDeleteResponse: … Result of a successful object deletion. key: Optional\[str] 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)>)