Graphon API

S3 · Objects

ListObjects

GET/{bucket}

Lists the objects in a bucket with marker pagination.

The first version of the list operation. Prefer ListObjectsV2. Older tools still send this one.

View as Markdown
Role
Viewer or higher
Support
Supported
  • The legacy listing, with marker pagination.
  • max-keys counts keys before storage groups them by the delimiter.
  • The response has no Delimiter element.

Path parameters

bucketstringrequired

The bucket name.

Query parameters

prefixstringoptional

Return only keys that start with this value.

delimiterstringoptional

Group the keys that contain this value after the prefix.

markerstringoptional

Return only keys after this key. Send the NextMarker of the previous page.

max-keysintegeroptional

The most keys to return. Storage clamps the value to 1 through 1,000.

Default: 1000

encoding-typestringoptional

Send url to percent-encode the keys, prefixes, and delimiter in the response.

url
Percent-encode the values. / stays as it is.

Headers

The workspace ID that must own the bucket. Another owner returns 403 AccessDenied.

Responses

200OK

One page of objects.

application/xml

ListBucketResultobjectrequired

The root element.

Namestring

The bucket name.

Prefixstring

The prefix of the request.

Markerstring

Always empty.

Present when IsTruncated is true. Send it as marker.

MaxKeysinteger

The page size that storage used.

true when more keys follow.

One element for each object.

One element for each group of keys.

Errors

Select an error in the response example to see its XML body. Any request can also get the common errors, such as SignatureDoesNotMatch.

404NoSuchBucket

No bucket has this name, or the bucket was deleted.

What to do: Check the bucket name. ListBuckets shows the buckets of the workspace.

403AccessDenied

The key does not have the role for this operation, or the bucket is in another workspace.

What to do: Use a key of the workspace that owns the bucket, with the role above.

Was this page helpful?