List Object Storage bucket contents

get

https://api.linode.com/{apiVersion}/object-storage/buckets/{regionId}/{bucket}/object-list

Returns the contents of a bucket. The contents are paginated using a marker, that's the name of the last object on the previous page. Objects can also be filtered by prefix and delimiter. See Filtering and sorting for more information.

Permissions and scopes

To call this operation, you need permissions, based on the model you're using:

OAuth scopes. Your user needs these scopes assigned. Learn more.
- Scopes: object_storage:read_only

Path Params

apiVersion

string

enum

required

Enum Call either the v4 URL, or v4beta for operations still in Beta.

Allowed:

regionId

string

required

Identifies a region where this bucket lives.

📘
You can use a clusterId in place of regionId in requests for buckets that you created using the legacy version of the API. Run List clusters to see each cluster id.

bucket

string

required

The bucket name.

Query Params

marker

string

The "marker" for this request, which can be used to paginate through large buckets. Its value should be the value of the next_marker property returned with the last page. Listing bucket contents does not support arbitrary page access. See the next_marker property in the responses section for more details.

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 to 500

Defaults to 100

The number of items to return per page.

Responses

200One page of the requested bucket's contents.

defaultSee Errors for the range of possible error response codes.