Sign in
R2 Bucket

List Objects in R2 Bucket

Changed on

List objects in an R2 bucket with optional prefix and delimiter.

get/r2/buckets/{bucket_name}/objects

Request

  • Base URL: /cdn-cgi/local/explorer/api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /cdn-cgi/local/explorer/api/r2/buckets/{bucket_name}/objects
  • Auth: none declared

Path parameters

bucket_namestring required

Query parameters

prefixstring

Filter objects by key prefix

delimiterstring

Delimiter for directory-style listing (usually '/')

cursorstring

Pagination cursor from previous response

per_pageinteger

Maximum number of objects to return

Response

List objects response.

successtrue required

Whether the API call was successful.

Example response

{
  "errors": [],
  "messages": [],
  "success": true
}

Changes