v1

latestOpenAPI 3.0.3Proprietary2026-07-26162247330.6 KB

Buckets

List objects in a bucket

Lists objects visible in the named bucket on the specified branch, including those inherited from ancestor branches. Listing is served by the user's session (no customer S3 credentials required).

When delimiter is supplied (typically /), keys are collapsed into common prefixes (folders) so callers can render a folder-style browser; keys that do not contain the delimiter after prefix are returned as objects.

Note: This endpoint is currently in Private Beta.

get/projects/{project_id}/branches/{branch_id}/buckets/{bucket_name}/objects

Query parameters

prefixstring

Only list objects whose key starts with this prefix.

delimiterstring

Collapse keys sharing a common prefix up to the first occurrence of this delimiter (typically /) into the folders array.

cursorstring

Opaque pagination cursor returned as next_cursor by a previous call. Resume listing after the last item of the previous page.

limitinteger

Maximum number of items (objects + folders) to return.

Response

The list of objects and folders

foldersstring[] required

Common prefixes (folder names) collapsed under the requested delimiter. Empty when no delimiter was supplied.

prefixstring required

The prefix that was applied to this listing (echoed back).

next_cursorstring

Pagination cursor to pass as cursor on the next request. Empty when the listing is not truncated.

is_truncatedboolean required

True when more results exist beyond this page.