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.

Path Params
string
required
^[a-z0-9-]{1,60}$

The Neon project ID

string
required
^[a-z0-9-]{1,60}$

The Neon branch ID

string
required
length between 1 and 255

The bucket name

Query Params
string

Only list objects whose key starts with this prefix.

string

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

string

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

int32
1 to 1000
Defaults to 1000

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

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json