Retrieve compute endpoint details

GET/projects/{project_id}/endpoints/{endpoint_id}Retrieve compute endpoint details

Retrieves information about the specified compute endpoint. A compute endpoint is a Neon compute instance. An endpoint_id has an ep- prefix. For information about compute endpoints, see Manage computes.

Parameters

project_idstringpathrequired

The Neon project ID

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

endpoint_idstringpathrequired

The endpoint ID

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

Responses

objectEndpointResponse

endpointobjectrequired

Show child attributes

autoscaling_limit_max_cunumberrequired

minimum 0.25

autoscaling_limit_min_cunumberrequired

minimum 0.25

branch_idstringrequired

The ID of the branch this compute endpoint belongs to.

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

compute_release_versionstring

Attached compute's release version number.

created_atstring · date-timerequired

A timestamp indicating when the compute endpoint was created

creation_sourcestringrequired

The compute endpoint creation source

current_statestringrequired

Lifecycle state of the compute endpoint. `init`: being initialized. `active`: running and accepting connections. `idle`: suspended (scaled to zero).

one of "init", "active", "idle"

disabledbooleanrequired

Whether to restrict connections to the compute endpoint. Enabling this option schedules a suspend compute operation. A disabled compute endpoint cannot be enabled by a connection or console action.

hoststringrequired

The hostname of the compute endpoint. This is the hostname specified when connecting to a Neon database.

idstringrequired

The compute endpoint ID. Compute endpoint IDs have an `ep-` prefix. For example: `ep-little-smoke-851426`

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

last_activestring · date-time

A timestamp indicating when the compute endpoint was last active

namestring

Optional name of the compute endpoint

passwordless_accessbooleanrequired

Whether to permit passwordless access to the compute endpoint

pending_statestring

Lifecycle state of the compute endpoint. `init`: being initialized. `active`: running and accepting connections. `idle`: suspended (scaled to zero).

one of "init", "active", "idle"

pooler_enabledbooleanrequired

Deprecated. To use connection pooling, append `-pooler` to the endpoint ID in the connection string.

pooler_modestringrequired

Deprecated. The connection pooler mode. Neon supports PgBouncer in `transaction` mode only. Removal scheduled for June 20, 2026.

one of "transaction"

project_idstringrequired

The ID of the project this compute endpoint belongs to.

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

provisionerstringrequired

proxy_hoststringrequired

Deprecated. Use the `host` property instead.

region_idstringrequired

Cloud region where the resource's Postgres compute and storage reside (for example, `aws-us-east-1`). Valid values are returned by `GET /regions`.

settingsobjectrequired

A collection of settings for a compute endpoint

Show child attributes

pg_settingsobject

A raw representation of Postgres settings

pgbouncer_settingsobject

Deprecated. A raw representation of PgBouncer settings. Removal scheduled for June 20, 2026.

preload_librariesobject

The shared libraries to preload into the project's compute instances.

Show child attributes

enabled_librariesarray of string

Names of shared preload libraries to enable for the project.

Show child attributes

use_defaultsboolean

When true, the project's preload libraries include the platform default set in addition to any libraries listed in `enabled_libraries`.

started_atstring · date-time

A timestamp indicating when the compute endpoint was last started

suspend_timeout_secondsinteger · int64required

Duration of inactivity in seconds after which the compute endpoint is automatically suspended. The value `0` means use the default value. The value `-1` means never suspend. The default value is `300` seconds (5 minutes). The minimum value is `60` seconds (1 minute). The maximum value is `604800` seconds (1 week). For more information, see [Scale to zero configuration](https://neon.com/docs/manage/endpoints#scale-to-zero-configuration).

maximum 604800 · minimum -1

suspended_atstring · date-time

A timestamp indicating when the compute endpoint was last suspended

typestringrequired

Compute endpoint type. `read_write`: the primary read-write endpoint (one per branch). `read_only`: a read replica endpoint (multiple allowed per branch).

one of "read_only", "read_write"

updated_atstring · date-timerequired

A timestamp indicating when the compute endpoint was last updated

Example response

{
  "endpoint": {
    "autoscaling_limit_max_cu": 1,
    "autoscaling_limit_min_cu": 1,
    "branch_id": "br-aged-salad-637688",
    "created_at": "2022-11-23T17:42:25Z",
    "creation_source": "console",
    "current_state": "idle",
    "disabled": false,
    "host": "ep-little-smoke-851426.us-east-2.aws.neon.tech",
    "id": "ep-little-smoke-851426",
    "last_active": "2022-11-23T17:00:00Z",
    "passwordless_access": true,
    "pooler_enabled": false,
    "pooler_mode": "transaction",
    "project_id": "shiny-wind-028834",
    "provisioner": "k8s-pod",
    "proxy_host": "us-east-2.aws.neon.tech",
    "region_id": "aws-us-east-2",
    "settings": {
      "pg_settings": {}
    },
    "suspend_timeout_seconds": 10800,
    "type": "read_write",
    "updated_at": "2022-11-30T18:25:21Z"
  }
}

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

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"
}

Examples

project_idrequiredpath parameter

endpoint_idrequiredpath parameter

curl -X GET 'https://console.neon.tech/api/v2/projects/string/endpoints/string'

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

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

import requests

response = requests.request("GET", "https://console.neon.tech/api/v2/projects/string/endpoints/string")
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/endpoints/string", 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/endpoints/string");
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/endpoints/string"))
    .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/endpoints/string")
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/endpoints/string");
using var response = await client.SendAsync(request);

{
  "endpoint": {
    "autoscaling_limit_max_cu": 1,
    "autoscaling_limit_min_cu": 1,
    "branch_id": "br-aged-salad-637688",
    "created_at": "2022-11-23T17:42:25Z",
    "creation_source": "console",
    "current_state": "idle",
    "disabled": false,
    "host": "ep-little-smoke-851426.us-east-2.aws.neon.tech",
    "id": "ep-little-smoke-851426",
    "last_active": "2022-11-23T17:00:00Z",
    "passwordless_access": true,
    "pooler_enabled": false,
    "pooler_mode": "transaction",
    "project_id": "shiny-wind-028834",
    "provisioner": "k8s-pod",
    "proxy_host": "us-east-2.aws.neon.tech",
    "region_id": "aws-us-east-2",
    "settings": {
      "pg_settings": {}
    },
    "suspend_timeout_seconds": 10800,
    "type": "read_write",
    "updated_at": "2022-11-30T18:25:21Z"
  }
}

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