Neon API (unofficial showcase)
GET/projects/{project_id}/branches/{branch_id}/buckets/{bucket_name}/objects

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 Beta.

7 parameters
project_idstringrequired
The Neon project ID
branch_idstringrequired
The Neon branch ID
bucket_namestringrequired
The bucket name
prefixstringoptional
Only list objects whose key starts with this prefix.
delimiterstringoptional
Collapse keys sharing a common prefix up to the first occurrence of this delimiter (typically `/`) into the `folders` array.
cursorstringoptional
Opaque pagination cursor returned as `next_cursor` by a previous call. Resume listing after the last item of the previous page.
limitintegeroptional
Maximum number of items (objects + folders) to return.
Default:1000

2 status codes
200The list of objects and folders
foldersarray<string>required
Common prefixes (folder names) collapsed under the requested `delimiter`. Empty when no `delimiter` was supplied.
objectsarray<object>required
Objects whose keys did not collapse into a folder.
prefixstringrequired
The prefix that was applied to this listing (echoed back).
next_cursorstringoptional
Pagination cursor to pass as `cursor` on the next request. Empty when the listing is not truncated.
is_truncatedbooleanrequired
True when more results exist beyond this page.
defaultGeneral Error. The request may or may not be safe to retry, depending on the HTTP method, response status code, and whether a response was received. - If no response is returned from the API, a network error or timeout likely occurred. - In some cases, the request may have reached the server and been successfully processed, but the response failed to reach the client. As a result, retrying non-idempotent requests can lead to unintended results. The following HTTP methods are considered non-idempotent: `POST`, `PATCH`, `DELETE`, and `PUT`. Retrying these methods is generally **not safe**. The following methods are considered idempotent: `GET`, `HEAD`, and `OPTIONS`. Retrying these methods is **safe** in the event of a network error or timeout. Any request that returns a `503 Service Unavailable` response is always safe to retry. Any request that returns a `423 Locked` response is safe to retry. `423 Locked` indicates that the resource is temporarily locked, for example, due to another operation in progress.
request_idstringoptional
Unique identifier for the request, useful for debugging. You can set this value manually by including an `X-Request-ID` header in the request. If not provided, the value will be generated automatically.
codestringrequired
Machine-readable code classifying the error type. See `message` for a human-readable explanation.
Default:
messagestringrequired
Error message

Error handling

Any other status is an error: General Error.

The request may or may not be safe to retry, depending on the HTTP method, response status code, and whether a response was received.

  • If no response is returned from the API, a network error or timeout likely occurred.
  • In some cases, the request may have reached the server and been successfully processed, but the response failed to reach the client. As a result, retrying non-idempotent requests can lead to unintended results.

The following HTTP methods are considered non-idempotent: POST, PATCH, DELETE, and PUT. Retrying these methods is generally not safe. The following methods are considered idempotent: GET, HEAD, and OPTIONS. Retrying these methods is safe in the event of a network error or timeout.

Any request that returns a 503 Service Unavailable response is always safe to retry.

Any request that returns a 423 Locked response is safe to retry. 423 Locked indicates that the resource is temporarily locked, for example, due to another operation in progress.