/projects/{project_id}/branches/{branch_id}/buckets/{bucket_name}/objectsbetaList 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.
Quick start
curl "https://console.neon.tech/api/v2/projects/$PROJECT_ID/branches/$BRANCH_ID/buckets/$BUCKET_NAME/objects" \
-H "Authorization: Bearer $NEON_API_KEY"Every field below is optional. An empty body works too.
import { createNeonClient, raw } from '@neon/sdk';
const neon = createNeonClient({ apiKey: process.env.NEON_API_KEY });
const { data } = await raw.listProjectBranchBucketObjects({
client: neon.client,
path: {
project_id: process.env.PROJECT_ID,
branch_id: process.env.BRANCH_ID,
bucket_name: process.env.BUCKET_NAME
}
});Parameters
project_idThe Neon project ID
branch_idThe Neon branch ID
bucket_nameThe bucket name
prefixOnly list objects whose key starts with this prefix.
delimiterCollapse keys sharing a common prefix up to the first occurrence of
this delimiter (typically /) into the folders array.
cursorOpaque pagination cursor returned as next_cursor by a previous
call. Resume listing after the last item of the previous page.
limitMaximum number of items (objects + folders) to return.
Response
200The list of objects and folders
Errors
General error
This endpoint can return the standard Neon API error response.
Response fields
messageRequired. Human-readable error message.codeRequired. Machine-readable error code.request_idOptional. Request identifier for debugging. You can provide one with theX-Request-IDheader.
Retry guidance
If no response is returned, the request may still have reached the server. This is why retry safety depends on the method and status code.
Idempotent methods (GET, HEAD, OPTIONS) are generally safe to retry after a network error or timeout. Non-idempotent methods (POST, PATCH, DELETE, PUT) can change state, so avoid automatic retries unless your workflow can tolerate duplicate effects.
Responses with 423 Locked or 503 Service Unavailable are safe to retry. 423 Locked means the resource is temporarily locked, usually because another operation is in progress.