--- title: R2 --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/typescript) 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/typescript/resources/r2/subresources/buckets/methods/list) client.r2.buckets.list(BucketListParams {account\_id, cursor, direction, 5 more } params, RequestOptionsoptions?): [BucketListResponse]() {buckets } GET/accounts/{account\_id}/r2/buckets ##### [Get Bucket](https://developers.cloudflare.com/api/typescript/resources/r2/subresources/buckets/methods/get) client.r2.buckets.get(stringbucketName, BucketGetParams {account\_id, cfR2Jurisdiction } params, RequestOptionsoptions?): [Bucket]() {creation\_date, jurisdiction, location, 2 more } GET/accounts/{account\_id}/r2/buckets/{bucket\_name} ##### [Create Bucket](https://developers.cloudflare.com/api/typescript/resources/r2/subresources/buckets/methods/create) client.r2.buckets.create(BucketCreateParams {account\_id, name, locationHint, 2 more } params, RequestOptionsoptions?): [Bucket]() {creation\_date, jurisdiction, location, 2 more } POST/accounts/{account\_id}/r2/buckets ##### [Patch Bucket](https://developers.cloudflare.com/api/typescript/resources/r2/subresources/buckets/methods/edit) client.r2.buckets.edit(stringbucketName, BucketEditParams {account\_id, storage\_class, cfR2Jurisdiction } params, RequestOptionsoptions?): [Bucket]() {creation\_date, jurisdiction, location, 2 more } PATCH/accounts/{account\_id}/r2/buckets/{bucket\_name} ##### [Delete Bucket](https://developers.cloudflare.com/api/typescript/resources/r2/subresources/buckets/methods/delete) client.r2.buckets.delete(stringbucketName, BucketDeleteParams {account\_id, cfR2Jurisdiction } params, RequestOptionsoptions?): [BucketDeleteResponse]() DELETE/accounts/{account\_id}/r2/buckets/{bucket\_name} ##### ModelsExpand Collapse
Bucket {creation\_date, jurisdiction, location, 2 more } A single R2 bucket. creation\_date?: string Creation timestamp. Link to this property
jurisdiction?: "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?: "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?: string Name of the bucket. maxLength64 minLength3 Link to this property
storage\_class?: "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)>)
BucketListResponse {buckets }
buckets?: Array<Bucket {creation\_date, jurisdiction, location, 2 more } > creation\_date?: string Creation timestamp. Link to this property
jurisdiction?: "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?: "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?: string Name of the bucket. maxLength64 minLength3 Link to this property
storage\_class?: "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)>) 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/typescript/resources/r2/subresources/buckets/subresources/lifecycle/methods/get) client.r2.buckets.lifecycle.get(stringbucketName, LifecycleGetParams {account\_id, cfR2Jurisdiction } params, RequestOptionsoptions?): [LifecycleGetResponse]() {rules } GET/accounts/{account\_id}/r2/buckets/{bucket\_name}/lifecycle ##### [Set Object Lifecycle Rules](https://developers.cloudflare.com/api/typescript/resources/r2/subresources/buckets/subresources/lifecycle/methods/update) client.r2.buckets.lifecycle.update(stringbucketName, LifecycleUpdateParams {account\_id, rules, cfR2Jurisdiction } params, RequestOptionsoptions?): [LifecycleUpdateResponse]() PUT/accounts/{account\_id}/r2/buckets/{bucket\_name}/lifecycle ##### ModelsExpand Collapse
LifecycleGetResponse {rules }
rules?: Array<Rule> id: string Unique identifier for this rule. Link to this property
conditions: Conditions {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?: AbortMultipartUploadsTransition {condition } Transition to abort ongoing multipart uploads.
condition?: Condition {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?: DeleteObjectsTransition {condition } Transition to delete objects.
condition?: R2LifecycleAgeCondition {maxAge, type } | R2LifecycleDateCondition {date, type } Condition for lifecycle transitions to apply after an object reaches an age in seconds. One of the following:
R2LifecycleAgeCondition {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 {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?: Array<StorageClassTransition> Transitions to change the storage class of objects.
condition: R2LifecycleAgeCondition {maxAge, type } | R2LifecycleDateCondition {date, type } Condition for lifecycle transitions to apply after an object reaches an age in seconds. One of the following:
R2LifecycleAgeCondition {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 {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/typescript/resources/r2/subresources/buckets/subresources/cors/methods/get) client.r2.buckets.cors.get(stringbucketName, CORSGetParams {account\_id, cfR2Jurisdiction } params, RequestOptionsoptions?): [CORSGetResponse]() {rules } GET/accounts/{account\_id}/r2/buckets/{bucket\_name}/cors ##### [Set Bucket CORS Policy](https://developers.cloudflare.com/api/typescript/resources/r2/subresources/buckets/subresources/cors/methods/update) client.r2.buckets.cors.update(stringbucketName, CORSUpdateParams {account\_id, rules, cfR2Jurisdiction } params, RequestOptionsoptions?): [CORSUpdateResponse]() PUT/accounts/{account\_id}/r2/buckets/{bucket\_name}/cors ##### [Delete Bucket CORS Policy](https://developers.cloudflare.com/api/typescript/resources/r2/subresources/buckets/subresources/cors/methods/delete) client.r2.buckets.cors.delete(stringbucketName, CORSDeleteParams {account\_id, cfR2Jurisdiction } params, RequestOptionsoptions?): [CORSDeleteResponse]() DELETE/accounts/{account\_id}/r2/buckets/{bucket\_name}/cors ##### ModelsExpand Collapse
CORSGetResponse {rules }
rules?: Array<Rule>
allowed: Allowed {methods, origins, headers } Object specifying allowed origins, methods and headers for this CORS rule.
methods: Array<"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: Array<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?: Array<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?: string Identifier for this rule. Link to this property exposeHeaders?: Array<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?: 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/typescript/resources/r2/subresources/buckets/subresources/domains/subresources/custom/methods/list) client.r2.buckets.domains.custom.list(stringbucketName, CustomListParams {account\_id, cfR2Jurisdiction } params, RequestOptionsoptions?): [CustomListResponse]() {domains } GET/accounts/{account\_id}/r2/buckets/{bucket\_name}/domains/custom ##### [Get Custom Domain Settings](https://developers.cloudflare.com/api/typescript/resources/r2/subresources/buckets/subresources/domains/subresources/custom/methods/get) client.r2.buckets.domains.custom.get(stringdomain, CustomGetParams {account\_id, bucket\_name, cfR2Jurisdiction } params, RequestOptionsoptions?): [CustomGetResponse]() {domain, enabled, status, 4 more } GET/accounts/{account\_id}/r2/buckets/{bucket\_name}/domains/custom/{domain} ##### [Attach Custom Domain To Bucket](https://developers.cloudflare.com/api/typescript/resources/r2/subresources/buckets/subresources/domains/subresources/custom/methods/create) client.r2.buckets.domains.custom.create(stringbucketName, CustomCreateParams {account\_id, domain, enabled, 4 more } params, RequestOptionsoptions?): [CustomCreateResponse]() {domain, enabled, zoneId, 2 more } POST/accounts/{account\_id}/r2/buckets/{bucket\_name}/domains/custom ##### [Configure Custom Domain Settings](https://developers.cloudflare.com/api/typescript/resources/r2/subresources/buckets/subresources/domains/subresources/custom/methods/update) client.r2.buckets.domains.custom.update(stringdomain, CustomUpdateParams {account\_id, bucket\_name, ciphers, 3 more } params, RequestOptionsoptions?): [CustomUpdateResponse]() {domain, ciphers, enabled, minTLS } PUT/accounts/{account\_id}/r2/buckets/{bucket\_name}/domains/custom/{domain} ##### [Remove Custom Domain From Bucket](https://developers.cloudflare.com/api/typescript/resources/r2/subresources/buckets/subresources/domains/subresources/custom/methods/delete) client.r2.buckets.domains.custom.delete(stringdomain, CustomDeleteParams {account\_id, bucket\_name, cfR2Jurisdiction } params, RequestOptionsoptions?): [CustomDeleteResponse]() {domain } DELETE/accounts/{account\_id}/r2/buckets/{bucket\_name}/domains/custom/{domain} ##### ModelsExpand Collapse
CustomListResponse {domains }
domains: Array<Domain> 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: Status {ownership, ssl }
ownership: "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: "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?: Array<string> An allowlist of ciphers for TLS termination. These ciphers must be in the BoringSSL format. Link to this property
minTLS?: "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 zoneId?: string Zone ID of the custom domain resides in. Link to this property zoneName?: 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 {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: Status {ownership, ssl }
ownership: "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: "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?: Array<string> An allowlist of ciphers for TLS termination. These ciphers must be in the BoringSSL format. Link to this property
minTLS?: "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 zoneId?: string Zone ID of the custom domain resides in. Link to this property zoneName?: 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 {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?: Array<string> An allowlist of ciphers for TLS termination. These ciphers must be in the BoringSSL format. Link to this property
minTLS?: "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)>)
CustomUpdateResponse {domain, ciphers, enabled, minTLS } domain: string Domain name of the affected custom domain. Link to this property ciphers?: Array<string> An allowlist of ciphers for TLS termination. These ciphers must be in the BoringSSL format. Link to this property enabled?: boolean Whether this bucket is publicly accessible at the specified custom domain. Link to this property
minTLS?: "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)>)
CustomDeleteResponse {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/typescript/resources/r2/subresources/buckets/subresources/domains/subresources/managed/methods/list) client.r2.buckets.domains.managed.list(stringbucketName, ManagedListParams {account\_id, cfR2Jurisdiction } params, RequestOptionsoptions?): [ManagedListResponse]() {bucketId, domain, enabled } GET/accounts/{account\_id}/r2/buckets/{bucket\_name}/domains/managed ##### [Update r2.dev Domain of Bucket](https://developers.cloudflare.com/api/typescript/resources/r2/subresources/buckets/subresources/domains/subresources/managed/methods/update) client.r2.buckets.domains.managed.update(stringbucketName, ManagedUpdateParams {account\_id, enabled, cfR2Jurisdiction } params, RequestOptionsoptions?): [ManagedUpdateResponse]() {bucketId, domain, enabled } PUT/accounts/{account\_id}/r2/buckets/{bucket\_name}/domains/managed ##### ModelsExpand Collapse
ManagedListResponse {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 {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/typescript/resources/r2/subresources/buckets/subresources/event_notifications/methods/list) client.r2.buckets.eventNotifications.list(stringbucketName, EventNotificationListParams {account\_id, cfR2Jurisdiction } params, RequestOptionsoptions?): [EventNotificationListResponse]() {bucketName, queues } GET/accounts/{account\_id}/event\_notifications/r2/{bucket\_name}/configuration ##### [Get Event Notification Rules for a Queue](https://developers.cloudflare.com/api/typescript/resources/r2/subresources/buckets/subresources/event_notifications/methods/get) client.r2.buckets.eventNotifications.get(stringqueueID, EventNotificationGetParams {account\_id, bucket\_name, cfR2Jurisdiction } params, RequestOptionsoptions?): [EventNotificationGetResponse]() {queueId, queueName, rules } GET/accounts/{account\_id}/event\_notifications/r2/{bucket\_name}/configuration/queues/{queue\_id} ##### [Create Event Notification Rules](https://developers.cloudflare.com/api/typescript/resources/r2/subresources/buckets/subresources/event_notifications/methods/update) client.r2.buckets.eventNotifications.update(stringqueueID, EventNotificationUpdateParams {account\_id, bucket\_name, rules, cfR2Jurisdiction } params, RequestOptionsoptions?): [EventNotificationUpdateResponse]() PUT/accounts/{account\_id}/event\_notifications/r2/{bucket\_name}/configuration/queues/{queue\_id} ##### [Delete Event Notification Rules](https://developers.cloudflare.com/api/typescript/resources/r2/subresources/buckets/subresources/event_notifications/methods/delete) client.r2.buckets.eventNotifications.delete(stringqueueID, EventNotificationDeleteParams {account\_id, bucket\_name, cfR2Jurisdiction } params, RequestOptionsoptions?): [EventNotificationDeleteResponse]() DELETE/accounts/{account\_id}/event\_notifications/r2/{bucket\_name}/configuration/queues/{queue\_id} ##### ModelsExpand Collapse
EventNotificationListResponse {bucketName, queues } bucketName?: string Name of the bucket. Link to this property
queues?: Array<Queue> List of queues associated with the bucket. queueId?: string Queue ID. Link to this property queueName?: string Name of the queue. Link to this property
rules?: Array<Rule>
actions: Array<"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 createdAt?: string Timestamp when the rule was created. Link to this property description?: string A description that can be used to identify the event notification rule after creation. Link to this property prefix?: string Notifications will be sent only for objects with this prefix. Link to this property ruleId?: string Rule ID. Link to this property suffix?: 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 {queueId, queueName, rules } queueId?: string Queue ID. Link to this property queueName?: string Name of the queue. Link to this property
rules?: Array<Rule>
actions: Array<"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 createdAt?: string Timestamp when the rule was created. Link to this property description?: string A description that can be used to identify the event notification rule after creation. Link to this property prefix?: string Notifications will be sent only for objects with this prefix. Link to this property ruleId?: string Rule ID. Link to this property suffix?: 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/typescript/resources/r2/subresources/buckets/subresources/locks/methods/get) client.r2.buckets.locks.get(stringbucketName, LockGetParams {account\_id, cfR2Jurisdiction } params, RequestOptionsoptions?): [LockGetResponse]() {rules } GET/accounts/{account\_id}/r2/buckets/{bucket\_name}/lock ##### [Set Bucket Lock Rules](https://developers.cloudflare.com/api/typescript/resources/r2/subresources/buckets/subresources/locks/methods/update) client.r2.buckets.locks.update(stringbucketName, LockUpdateParams {account\_id, rules, cfR2Jurisdiction } params, RequestOptionsoptions?): [LockUpdateResponse]() PUT/accounts/{account\_id}/r2/buckets/{bucket\_name}/lock ##### ModelsExpand Collapse
LockGetResponse {rules }
rules?: Array<Rule> id: string Unique identifier for this rule. Link to this property
condition: R2LockRuleAgeCondition {maxAgeSeconds, type } | R2LockRuleDateCondition {date, type } | R2LockRuleIndefiniteCondition {type } Condition to apply a lock rule to an object for how long in seconds. One of the following:
R2LockRuleAgeCondition {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 {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 {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?: 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/typescript/resources/r2/subresources/buckets/subresources/metrics/methods/list) client.r2.buckets.metrics.list(MetricListParams {account\_id } params, RequestOptionsoptions?): [MetricListResponse]() {infrequentAccess, standard } GET/accounts/{account\_id}/r2/metrics ##### ModelsExpand Collapse
MetricListResponse {infrequentAccess, standard } Metrics based on the class they belong to.
infrequentAccess?: InfrequentAccess {published, uploaded } Metrics based on what state they are in(uploaded or published).
published?: Published {metadataSize, objects, payloadSize } Metrics on number of objects/amount of storage used. metadataSize?: number Amount of. Link to this property objects?: number Number of objects stored. Link to this property payloadSize?: number Amount of storage used by object data. Link to this property
Link to this property
uploaded?: Uploaded {metadataSize, objects, payloadSize } Metrics on number of objects/amount of storage used. metadataSize?: number Amount of. Link to this property objects?: number Number of objects stored. Link to this property payloadSize?: number Amount of storage used by object data. Link to this property
Link to this property
Link to this property
standard?: Standard {published, uploaded } Metrics based on what state they are in(uploaded or published).
published?: Published {metadataSize, objects, payloadSize } Metrics on number of objects/amount of storage used. metadataSize?: number Amount of. Link to this property objects?: number Number of objects stored. Link to this property payloadSize?: number Amount of storage used by object data. Link to this property
Link to this property
uploaded?: Uploaded {metadataSize, objects, payloadSize } Metrics on number of objects/amount of storage used. metadataSize?: number Amount of. Link to this property objects?: number Number of objects stored. Link to this property payloadSize?: 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/typescript/resources/r2/subresources/buckets/subresources/sippy/methods/get) client.r2.buckets.sippy.get(stringbucketName, SippyGetParams {account\_id, cfR2Jurisdiction } params, RequestOptionsoptions?): [Sippy]() {destination, enabled, source } GET/accounts/{account\_id}/r2/buckets/{bucket\_name}/sippy ##### [Enable Sippy](https://developers.cloudflare.com/api/typescript/resources/r2/subresources/buckets/subresources/sippy/methods/update) client.r2.buckets.sippy.update(stringbucketName, SippyUpdateParamsparams, RequestOptionsoptions?): [Sippy]() {destination, enabled, source } PUT/accounts/{account\_id}/r2/buckets/{bucket\_name}/sippy ##### [Disable Sippy](https://developers.cloudflare.com/api/typescript/resources/r2/subresources/buckets/subresources/sippy/methods/delete) client.r2.buckets.sippy.delete(stringbucketName, SippyDeleteParams {account\_id, cfR2Jurisdiction } params, RequestOptionsoptions?): [SippyDeleteResponse]() {enabled } 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 {destination, enabled, source }
destination?: Destination {accessKeyId, account, bucket, provider } Details about the configured destination bucket. accessKeyId?: string ID of the Cloudflare API token used when writing objects to this bucket. Link to this property account?: string Link to this property bucket?: string Name of the bucket on the provider. Link to this property provider?: Provider {} Link to this property
Link to this property enabled?: boolean State of Sippy for this bucket. Link to this property
source?: Source {bucket, bucketUrl, container, 2 more } Details about the configured source bucket. bucket?: string| null Name of the bucket on the provider (AWS, GCS only). Link to this property bucketUrl?: string| null S3-compatible URL (Generic S3-compatible providers only). Link to this property container?: string| null Name of the Azure Blob Storage container (Azure only). Link to this property
provider?: "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?: string| null 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 {enabled } enabled?: 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/typescript/resources/r2/subresources/buckets/subresources/objects/methods/list) client.r2.buckets.objects.list(stringbucketName, ObjectListParams {account\_id, cursor, delimiter, 4 more } params, RequestOptionsoptions?): CursorPagination< [ObjectListResponse]() {custom\_metadata, etag, http\_metadata, 5 more } > GET/accounts/{account\_id}/r2/buckets/{bucket\_name}/objects ##### [Get Object](https://developers.cloudflare.com/api/typescript/resources/r2/subresources/buckets/subresources/objects/methods/get) client.r2.buckets.objects.get(stringobjectKey, ObjectGetParams {account\_id, bucket\_name, cfR2Jurisdiction, 2 more } params, RequestOptionsoptions?): Response GET/accounts/{account\_id}/r2/buckets/{bucket\_name}/objects/{object\_key} ##### [Upload Object](https://developers.cloudflare.com/api/typescript/resources/r2/subresources/buckets/subresources/objects/methods/upload) client.r2.buckets.objects.upload(stringobjectKey, "string"| "ArrayBuffer"| "ArrayBufferView"| 2 morebody, ObjectUploadParams {account\_id, bucket\_name, cfR2Jurisdiction, cfR2StorageClass } params, RequestOptionsoptions?): [ObjectUploadResponse]() {etag, key, size, 3 more } PUT/accounts/{account\_id}/r2/buckets/{bucket\_name}/objects/{object\_key} ##### [Delete Object](https://developers.cloudflare.com/api/typescript/resources/r2/subresources/buckets/subresources/objects/methods/delete) client.r2.buckets.objects.delete(stringobjectKey, ObjectDeleteParams {account\_id, bucket\_name, cfR2Jurisdiction } params, RequestOptionsoptions?): [ObjectDeleteResponse]() {key } DELETE/accounts/{account\_id}/r2/buckets/{bucket\_name}/objects/{object\_key} ##### ModelsExpand Collapse
ObjectListResponse {custom\_metadata, etag, http\_metadata, 5 more } Metadata for an R2 object. custom\_metadata?: Record<string, string> Custom metadata key-value pairs associated with the object. Link to this property etag?: 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?: HTTPMetadata {cacheControl, cacheExpiry, contentDisposition, 3 more } HTTP metadata associated with an R2 object. cacheControl?: string Specifies caching behavior for the object. Link to this property cacheExpiry?: string The date and time at which the object’s cache entry expires. formatdate-time Link to this property contentDisposition?: string Specifies presentational information for the object. Link to this property contentEncoding?: string Specifies the content encoding applied to the object. Link to this property contentLanguage?: string The language of the object content. Link to this property contentType?: string The MIME type of the object. Link to this property
Link to this property key?: string The object key (name). Link to this property last\_modified?: string The date and time the object was last modified. formatdate-time Link to this property size?: number The size of the object in bytes. Link to this property ssec?: boolean Whether the object is encrypted with a customer-supplied encryption key. Link to this property
storage\_class?: "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)>)
ObjectUploadResponse {etag, key, size, 3 more } Result of a successful object upload. etag?: string The entity tag for the uploaded object. Link to this property key?: string The key (name) of the uploaded object. Link to this property size?: string The size of the uploaded object in bytes (as a string). Link to this property
storage\_class?: "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?: string The date and time the object was uploaded. formatdate-time Link to this property version?: 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 {key } Result of a successful object deletion. key?: 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/typescript/resources/r2/subresources/temporary_credentials/methods/create) client.r2.temporaryCredentials.create(TemporaryCredentialCreateParams {account\_id, bucket, parentAccessKeyId, 4 more } params, RequestOptionsoptions?): [TemporaryCredentialCreateResponse]() {accessKeyId, secretAccessKey, sessionToken } POST/accounts/{account\_id}/r2/temp-access-credentials ##### ModelsExpand Collapse
TemporaryCredential {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"| "admin-read-only"| "object-read-write"| "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?: Array<string> Optional object paths to scope the credentials to. Link to this property prefixes?: Array<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 {accessKeyId, secretAccessKey, sessionToken } accessKeyId?: string ID for new access key. Link to this property secretAccessKey?: string Secret access key. Link to this property sessionToken?: 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/typescript/resources/r2/subresources/super_slurper/subresources/jobs/methods/list) client.r2.superSlurper.jobs.list(JobListParams {account\_id, limit, offset } params, RequestOptionsoptions?): SinglePage< [JobListResponse]() {id, createdAt, finishedAt, 4 more } > GET/accounts/{account\_id}/slurper/jobs ##### [Get job details](https://developers.cloudflare.com/api/typescript/resources/r2/subresources/super_slurper/subresources/jobs/methods/get) client.r2.superSlurper.jobs.get(stringjobID, JobGetParams {account\_id } params, RequestOptionsoptions?): [JobGetResponse]() {id, createdAt, finishedAt, 4 more } GET/accounts/{account\_id}/slurper/jobs/{job\_id} ##### [Create a job](https://developers.cloudflare.com/api/typescript/resources/r2/subresources/super_slurper/subresources/jobs/methods/create) client.r2.superSlurper.jobs.create(JobCreateParams {account\_id, overwrite, source, target } params, RequestOptionsoptions?): [JobCreateResponse]() {id } POST/accounts/{account\_id}/slurper/jobs ##### [Abort all jobs](https://developers.cloudflare.com/api/typescript/resources/r2/subresources/super_slurper/subresources/jobs/methods/abort_all) client.r2.superSlurper.jobs.abortAll(JobAbortAllParams {account\_id } params, RequestOptionsoptions?): [JobAbortAllResponse]() PUT/accounts/{account\_id}/slurper/jobs/abortAll ##### [Abort a job](https://developers.cloudflare.com/api/typescript/resources/r2/subresources/super_slurper/subresources/jobs/methods/abort) client.r2.superSlurper.jobs.abort(stringjobID, JobAbortParams {account\_id } params, RequestOptionsoptions?): [JobAbortResponse]() PUT/accounts/{account\_id}/slurper/jobs/{job\_id}/abort ##### [Pause a job](https://developers.cloudflare.com/api/typescript/resources/r2/subresources/super_slurper/subresources/jobs/methods/pause) client.r2.superSlurper.jobs.pause(stringjobID, JobPauseParams {account\_id } params, RequestOptionsoptions?): [JobPauseResponse]() PUT/accounts/{account\_id}/slurper/jobs/{job\_id}/pause ##### [Get job progress](https://developers.cloudflare.com/api/typescript/resources/r2/subresources/super_slurper/subresources/jobs/methods/progress) client.r2.superSlurper.jobs.progress(stringjobID, JobProgressParams {account\_id } params, RequestOptionsoptions?): [JobProgressResponse]() {id, createdAt, failedObjects, 4 more } GET/accounts/{account\_id}/slurper/jobs/{job\_id}/progress ##### [Resume a job](https://developers.cloudflare.com/api/typescript/resources/r2/subresources/super_slurper/subresources/jobs/methods/resume) client.r2.superSlurper.jobs.resume(stringjobID, JobResumeParams {account\_id } params, RequestOptionsoptions?): [JobResumeResponse]() PUT/accounts/{account\_id}/slurper/jobs/{job\_id}/resume ##### ModelsExpand Collapse
JobListResponse {id, createdAt, finishedAt, 4 more } id?: string Link to this property createdAt?: string Link to this property finishedAt?: string| null Link to this property overwrite?: boolean Link to this property
source?: S3SourceResponseSchema {bucket, endpoint, keys, 2 more } | GcsSourceResponseSchema {bucket, keys, pathPrefix, vendor } | R2SourceResponseSchema {bucket, jurisdiction, keys, 2 more } One of the following:
S3SourceResponseSchema {bucket, endpoint, keys, 2 more } bucket?: string Link to this property endpoint?: string| null formaturi Link to this property keys?: Array<string>| null Link to this property pathPrefix?: string| null Link to this property vendor?: "s3" Link to this property
Link to this property
GcsSourceResponseSchema {bucket, keys, pathPrefix, vendor } bucket?: string Link to this property keys?: Array<string>| null Link to this property pathPrefix?: string| null Link to this property vendor?: "gcs" Link to this property
Link to this property
R2SourceResponseSchema {bucket, jurisdiction, keys, 2 more } bucket?: string Link to this property
jurisdiction?: "default"| "eu"| "us"| "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?: Array<string>| null Link to this property pathPrefix?: string| null Link to this property vendor?: Provider {} Link to this property
Link to this property
Link to this property
status?: "running"| "paused"| "aborted"| "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?: Target {bucket, jurisdiction, vendor } bucket?: string Link to this property
jurisdiction?: "default"| "eu"| "us"| "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?: 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 {id, createdAt, finishedAt, 4 more } id?: string Link to this property createdAt?: string Link to this property finishedAt?: string| null Link to this property overwrite?: boolean Link to this property
source?: S3SourceResponseSchema {bucket, endpoint, keys, 2 more } | GcsSourceResponseSchema {bucket, keys, pathPrefix, vendor } | R2SourceResponseSchema {bucket, jurisdiction, keys, 2 more } One of the following:
S3SourceResponseSchema {bucket, endpoint, keys, 2 more } bucket?: string Link to this property endpoint?: string| null formaturi Link to this property keys?: Array<string>| null Link to this property pathPrefix?: string| null Link to this property vendor?: "s3" Link to this property
Link to this property
GcsSourceResponseSchema {bucket, keys, pathPrefix, vendor } bucket?: string Link to this property keys?: Array<string>| null Link to this property pathPrefix?: string| null Link to this property vendor?: "gcs" Link to this property
Link to this property
R2SourceResponseSchema {bucket, jurisdiction, keys, 2 more } bucket?: string Link to this property
jurisdiction?: "default"| "eu"| "us"| "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?: Array<string>| null Link to this property pathPrefix?: string| null Link to this property vendor?: Provider {} Link to this property
Link to this property
Link to this property
status?: "running"| "paused"| "aborted"| "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?: Target {bucket, jurisdiction, vendor } bucket?: string Link to this property
jurisdiction?: "default"| "eu"| "us"| "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?: 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 {id } id?: 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 {id, createdAt, failedObjects, 4 more } id?: string Link to this property createdAt?: string Link to this property failedObjects?: number Link to this property objects?: number Link to this property skippedObjects?: number Link to this property
status?: "running"| "paused"| "aborted"| "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?: 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/typescript/resources/r2/subresources/super_slurper/subresources/jobs/subresources/logs/methods/list) client.r2.superSlurper.jobs.logs.list(stringjobID, LogListParams {account\_id, limit, offset } params, RequestOptionsoptions?): SinglePage< [LogListResponse]() {createdAt, job, logType, 2 more } > GET/accounts/{account\_id}/slurper/jobs/{job\_id}/logs ##### ModelsExpand Collapse
LogListResponse {createdAt, job, logType, 2 more } createdAt?: string Link to this property job?: string Link to this property
logType?: "migrationStart"| "migrationComplete"| "migrationAbort"| 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?: string| null Link to this property objectKey?: string| null 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/typescript/resources/r2/subresources/super_slurper/subresources/connectivity_precheck/methods/source) client.r2.superSlurper.connectivityPrecheck.source(ConnectivityPrecheckSourceParamsparams, RequestOptionsoptions?): [ConnectivityPrecheckSourceResponse]() {connectivityStatus } PUT/accounts/{account\_id}/slurper/source/connectivity-precheck ##### [Check target connectivity](https://developers.cloudflare.com/api/typescript/resources/r2/subresources/super_slurper/subresources/connectivity_precheck/methods/target) client.r2.superSlurper.connectivityPrecheck.target(ConnectivityPrecheckTargetParams {account\_id, bucket, secret, 2 more } params, RequestOptionsoptions?): [ConnectivityPrecheckTargetResponse]() {connectivityStatus } PUT/accounts/{account\_id}/slurper/target/connectivity-precheck ##### ModelsExpand Collapse
ConnectivityPrecheckSourceResponse {connectivityStatus }
connectivityStatus?: "success"| "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 {connectivityStatus }
connectivityStatus?: "success"| "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)>)