Object Storage

List Object Storage Bucket Contents

get
https://api.linode.com/v4beta/object-storage/buckets/{clusterId}/{bucket}/object-list
BETA

Returns the contents of a bucket. The contents are paginated using a marker, which is the name of the last object on the previous page. Objects may be filtered by prefix and delimiter as well; see Query Parameters for more information.

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

Beta: This endpoint is in beta. Please make sure to prepend all requests with /v4beta instead of /v4, and be aware that this endpoint may receive breaking updates in the future. This notice will be removed when this endpoint is out of beta.

Authorizations

Personal Access Token
OAuth: ( object_storage:read_only)

Path Parameters

clusterId
Required
string

The ID of the cluster this bucket exists in.

bucket
Required
string

The bucket name.

Query Parameters

marker
string

The "marker" for this request, which can be used to paginate through large buckets. This should be the name of the last object on the last page of results. Listing bucket contents does not support arbitrary page access.

delimiter
string

The delimiter for object names; if given, object names will be returned up to the first occurrence of this character. This is most commonly used with the / character to allow bucket transversal in a manner similar to a filesystem, however any delimiter may be used. Use in conjunction with prefix to see object names past the first occurrence of the delimiter.

prefix
string

Filters objects returned to only those whose name start with the given prefix. Commonly used in conjunction with delimiter to allow transversal of bucket contents in a manner similar to a filesystem.

page_size
integer [25 .. 100]
Default: 100

The number of items to return per page.

Request Samples

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

Response Samples

{
  "data": [
    {
      "name": "example",
      "size": 123,
      "etag": "9f254c71e28e033bf9e0e5262e3e72ab",
      "last_modified": "2019-01-01T01:23:45.000Z",
      "owner": "bfc70ab2-e3d4-42a4-ad55-83921822270c"
    }
  ]
}

Responses

200: One page of the requested bucket's contents.

data
array of objects

This page of objects in the bucket.

name
string

The name of this object or prefix.

size
integer

The size of this object, in bytes. null if this object represents a prefix.

etag
string

An MD-5 hash of the object. null if this object represents a prefix.

last_modified
string

The date and time this object was last modified. null if this object represents a prefix.

owner
string

The owner of this object, as a UUID. null if this object represents a prefix.

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.