Download an object's bytes

Streams the raw bytes of the named object from the bucket on the
specified branch, including objects inherited from ancestor branches.
Served by the user's session (no customer S3 credentials required).

The body is returned as application/octet-stream so a browser treats
it as a download; the Content-Length and ETag response headers echo
the stored object metadata.

BINARY-STREAM EXCEPTION TO THE BUILD-GENERATED-TYPES RULE (#7029): the
successful 200 body is the raw object stream, proxied verbatim from the
platform storage admin endpoint. It is modeled as an
application/octet-stream binary body (not a JSON response schema) and
is streamed without buffering the whole object in memory. Error
responses still use the generated GeneralError shape.

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

string
required
length between 1 and 1024

The object key. Keys may contain /; the / characters of nested
keys must be percent-encoded (%2F) in the path segment.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

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