Download an object's bytes | Neon Postgres Docs

GET/projects/{project_id}/branches/{branch_id}/buckets/{bucket_name}/objects/{object_key}/downloadDownload 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 object 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 Beta.

Parameters

project_idstringpathrequired

The Neon project ID

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

branch_idstringpathrequired

The Neon branch ID

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

bucket_namestringpathrequired

The bucket name

maxLength 255 · minLength 1

object_keystringpathrequired

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

maxLength 1024 · minLength 1

Responses

Headers

Content-Disposition

Always `attachment`. Forces a download rather than inline rendering, neutralizing stored-XSS via the object body.

Content-Length

The object size in bytes.

ETag

The object's entity tag (content hash).

X-Content-Type-Options

Always `nosniff`. Stops the browser from MIME-sniffing the caller-controlled bytes into an executable type.

string · binary

Example response

"binary"

objectGeneralError

codestringrequired

default ""

messagestringrequired

Error message

request_idstring

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.

Example response

{
  "code": "",
  "message": "string",
  "request_id": "string"
}

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. application/json

objectGeneralError

codestringrequired

default ""

messagestringrequired

Error message

request_idstring

Example response

{
  "code": "",
  "message": "string",
  "request_id": "string"
}

Examples

project_idrequiredpath parameter

branch_idrequiredpath parameter

bucket_namerequiredpath parameter

object_keyrequiredpath parameter

curl -X GET 'https://console.neon.tech/api/v2/projects/string/branches/string/buckets/string/objects/string/download'

const response = await fetch('https://console.neon.tech/api/v2/projects/string/branches/string/buckets/string/objects/string/download', { method: 'GET' });
const data = await response.json();

const response = await fetch('https://console.neon.tech/api/v2/projects/string/branches/string/buckets/string/objects/string/download', { method: 'GET' });
console.log(await response.json());

import requests

response = requests.request("GET", "https://console.neon.tech/api/v2/projects/string/branches/string/buckets/string/objects/string/download")
print(response.json())

package main

import (
	"context"
	"net/http"
)

func main() {
	ctx := context.Background()
	req, err := http.NewRequestWithContext(ctx, "GET", "https://console.neon.tech/api/v2/projects/string/branches/string/buckets/string/objects/string/download", nil)
	if err != nil {
		panic(err)
	}
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("https://console.neon.tech/api/v2/projects/string/branches/string/buckets/string/objects/string/download");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "GET");
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("https://console.neon.tech/api/v2/projects/string/branches/string/buckets/string/objects/string/download"))
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://console.neon.tech/api/v2/projects/string/branches/string/buckets/string/objects/string/download")
request = Net::HTTPGenericRequest.new("GET", false, true, uri)
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://console.neon.tech/api/v2/projects/string/branches/string/buckets/string/objects/string/download");
using var response = await client.SendAsync(request);

"binary"

{
  "code": "",
  "message": "string",
  "request_id": "string"
}

{
  "code": "",
  "message": "string",
  "request_id": "string"
}