--- title: List Buckets --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/go) [R2](https://developers.cloudflare.com/api/go/resources/r2) [Buckets](https://developers.cloudflare.com/api/go/resources/r2/subresources/buckets) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # List Buckets client.R2.Buckets.List(ctx, params) (\*[BucketListResponse](), error) GET/accounts/{account\_id}/r2/buckets Lists a page of R2 buckets in the account and selected jurisdiction. Use the returned cursor to retrieve the next page. ##### Security API Token The preferred authorization scheme for interacting with the Cloudflare API. [Create a token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). **Example:**`Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY` ##### Accepted Permissions (at least one required) `Workers R2 Storage Write``Workers R2 Storage Read` ##### ParametersExpand Collapse
params BucketListParams AccountID param.Field\[string] Path param: Cloudflare account ID that owns the R2 resource. maxLength32 Link to this property Cursor param.Field\[string]Optional Query param: Pagination cursor received during the last List Buckets call. R2 buckets are paginated using cursors instead of page numbers. Link to this property
Direction param.Field\[BucketListParamsDirection]Optional Query param: Direction to order buckets. const BucketListParamsDirectionAsc BucketListParamsDirection = "asc" Link to this property const BucketListParamsDirectionDesc BucketListParamsDirection = "desc" Link to this property
Link to this property NameContains param.Field\[string]Optional Query param: Bucket names to filter by. Only buckets with this phrase in their name will be returned. Link to this property
Order param.Field\[BucketListParamsOrder]Optional Query param: Field to order buckets by. const BucketListParamsOrderName BucketListParamsOrder = "name" Link to this property
Link to this property PerPage param.Field\[float64]Optional Query param: Maximum number of buckets to return in a single call. maximum1000 minimum1 Link to this property StartAfter param.Field\[string]Optional Query param: Bucket name to start searching after. Buckets are ordered lexicographically. Link to this property
CfR2Jurisdiction param.Field\[BucketListParamsCfR2Jurisdiction]Optional Header param: Jurisdiction where objects in this bucket are guaranteed to be stored. const BucketListParamsCfR2JurisdictionDefault BucketListParamsCfR2Jurisdiction = "default" Link to this property const BucketListParamsCfR2JurisdictionEu BucketListParamsCfR2Jurisdiction = "eu" Link to this property const BucketListParamsCfR2JurisdictionUs BucketListParamsCfR2Jurisdiction = "us" Link to this property const BucketListParamsCfR2JurisdictionFedramp BucketListParamsCfR2Jurisdiction = "fedramp" Link to this property const BucketListParamsCfR2JurisdictionFedrampHigh BucketListParamsCfR2Jurisdiction = "fedramp-high" Link to this property
Link to this property
[Link to this property](<#(resource)%20r2.buckets%20%3E%20(method)%20list%20%3E%20(params)%20default>) ##### ReturnsExpand Collapse
type BucketListResponse struct{…}
Buckets \[]BucketOptional CreationDate stringOptional Creation timestamp. Link to this property
Jurisdiction BucketJurisdictionOptional Jurisdiction where objects in this bucket are guaranteed to be stored. One of the following: const BucketJurisdictionDefault BucketJurisdiction = "default" Link to this property const BucketJurisdictionEu BucketJurisdiction = "eu" Link to this property const BucketJurisdictionUs BucketJurisdiction = "us" Link to this property const BucketJurisdictionFedramp BucketJurisdiction = "fedramp" Link to this property const BucketJurisdictionFedrampHigh BucketJurisdiction = "fedramp-high" Link to this property
Link to this property
Location BucketLocationOptional Location of the bucket. One of the following: const BucketLocationApac BucketLocation = "apac" Link to this property const BucketLocationEeur BucketLocation = "eeur" Link to this property const BucketLocationEnam BucketLocation = "enam" Link to this property const BucketLocationWeur BucketLocation = "weur" Link to this property const BucketLocationWnam BucketLocation = "wnam" Link to this property const BucketLocationOc BucketLocation = "oc" Link to this property
Link to this property Name stringOptional Name of the bucket. maxLength64 minLength3 Link to this property
StorageClass BucketStorageClassOptional Storage class for newly uploaded objects, unless specified otherwise. One of the following: const BucketStorageClassStandard BucketStorageClass = "Standard" Link to this property const BucketStorageClassInfrequentAccess BucketStorageClass = "InfrequentAccess" Link to this property
Link to this property
Link to this property
[Link to this property](<#(resource)%20r2.buckets%20%3E%20(model)%20BucketListResponse%20%3E%20(schema)>) ### List Buckets Go HTTPTypeScriptPythonGoTerraform ``` package main import ( "context" "fmt" "github.com/cloudflare/cloudflare-go" "github.com/cloudflare/cloudflare-go/option" "github.com/cloudflare/cloudflare-go/r2" ) func main() { client := cloudflare.NewClient( option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"), ) buckets, err := client.R2.Buckets.List(context.TODO(), r2.BucketListParams{ AccountID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", buckets.Buckets) } ``` 200 example ``` { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ "string" ], "result": { "buckets": [ { "creation_date": "creation_date", "jurisdiction": "default", "location": "apac", "name": "example-bucket", "storage_class": "Standard" } ] }, "success": true, "result_info": { "cursor": "1-JTdCJTIydiUyMiUzQTElMkMlMjJzdGFydEFmdGVyJTIyJTNBJTIyZGF2aWRwdWJsaWMlMjIlN0Q=", "per_page": 20 } } ``` ##### Returns Examples 200 example ``` { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ "string" ], "result": { "buckets": [ { "creation_date": "creation_date", "jurisdiction": "default", "location": "apac", "name": "example-bucket", "storage_class": "Standard" } ] }, "success": true, "result_info": { "cursor": "1-JTdCJTIydiUyMiUzQTElMkMlMjJzdGFydEFmdGVyJTIyJTNBJTIyZGF2aWRwdWJsaWMlMjIlN0Q=", "per_page": 20 } } ```