List R2 buckets

GET

/api/v1/storage/r2

const url = 'https://digize.com/api/v1/storage/r2';
const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://digize.com/api/v1/storage/r2 \
  --header 'x-api-key: <x-api-key>'

The workspace’s R2 buckets with their objects, size, this month’s operations, public access and the workers that bind them.

Needs the sites:read permission.

Authorizations

apiKey
bearer

Responses

200

Done

application/json

Array<object>

object

name

required

string

cloudflareName

required

string

createdAt

required

string format: date-time

location

required

string

storageClass

required

string

Allowed values: Standard Infrequent Access

objects

required

number

sizeBytes

required

number

classA

required

number

classB

required

number

publicHostname

required

string | null

r2Dev

required

boolean

r2DevDomain

required

string | null

boundTo

required

Array<object>

object

worker

required

string

variable

required

string | null

live

required

boolean

Example

[
  {
    "storageClass": "Standard"
  }
]

400

What was sent isn’t valid (invalid).

application/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

401

No key, or one that’s unknown, off or expired.

application/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

403

The key doesn’t have the permission this needs.

application/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

404

Nothing has that id (not_found).

application/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

429

Over the rate limit; see retry-after.

application/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}