Object Storage
Object Storage Bucket Contents List
https://api.linode.com/v4/object-storage/buckets/{clusterId}/{bucket}/object-listReturns 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.
Path Parameters
The ID of the cluster this bucket exists in.
The bucket name.
Query Parameters
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.
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.
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.
The number of items to return per page.
Request Samples
- Shell
curl -H "Authorization: Bearer $TOKEN" \
https://api.linode.com/v4/object-storage/buckets/us-east-1/example-bucket/object-list
Response Samples
- 200
- default
{
"data": [
{
"name": "example",
"size": 123,
"etag": "9f254c71e28e033bf9e0e5262e3e72ab",
"last_modified": "2019-01-01T01:23:45.000Z",
"owner": "bfc70ab2-e3d4-42a4-ad55-83921822270c",
"next_marker": "bd021c21-e734-4823-97a4-58b41c2cd4c8.892602.184",
"is_truncated": true
}
]
}Responses
200: One page of the requested bucket's contents.
This page of objects in the bucket.
The name of this object or prefix.
The size of this object, in bytes. null if this object represents a prefix.
An MD-5 hash of the object. null if this object represents a prefix.
The date and time this object was last modified. null if this object represents a prefix.
The owner of this object, as a UUID. null if this object represents a prefix.
Returns the value you should pass to the marker query parameter to get the next page of objects. If there is no next page, null will be returned.
Designates if there is another page of bucket objects.
default: Error
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.
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.