Object Storage

List Object Storage Buckets in Cluster

get
https://api.linode.com/v4/object-storage/buckets/{clusterId}

Returns a list of Buckets in this cluster belonging to this Account.

This endpoint is available for convenience. It is recommended that instead you use the more fully-featured S3 API directly.

Authorizations

Personal Access Token
OAuth: ( object_storage:read_only)

Path Parameters

clusterId
Required
string

The ID of the cluster this bucket exists in.

Request Samples

curl -H "Authorization: Bearer $TOKEN" \
  https://api.linode.com/v4/object-storage/buckets/us-east-1

Response Samples

{
  "data": [
    {
      "created": "2019-01-01T01:23:45.000Z",
      "label": "example-bucket",
      "hostname": "example-bucket.us-east-1.linodeobjects.com",
      "cluster": "us-east-1"
    }
  ],
  "page": 1,
  "pages": 1,
  "results": 1
}

Responses

200: A paginated list of buckets you own in this cluster.

data
array of objects
created
string

When this bucket was created.

label
string

The name of this bucket.

hostname
string

The hostname where this bucket can be accessed. This hostname can be accessed through a browser if the bucket is made public.

cluster
string

The ID of the Object Storage Cluster this bucket is in.

page
integer
pages
integer
results
integer

default: Error

errors
array of objects
reason
string

What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.

field
string

The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as "null" if the error is not specific to any single element of the request.