List branch endpoints

Retrieves a list of compute endpoints for the specified branch.

GET /projects/{project_id}/branches/{branch_id}/endpoints

Retrieves a list of compute endpoints for the specified branch. Neon permits only one read-write compute endpoint per branch. A branch can have multiple read-only compute endpoints.

Markdown for AI context

REST API - curl

curl "https://console.neon.tech/api/v2/projects/$PROJECT_ID/branches/$BRANCH_ID/endpoints" \
  -H "Authorization: Bearer $NEON_API_KEY"

Every field below is optional. An empty body works too.

Also available in

TypeScript

import { createNeonClient, raw } from '@neon/sdk';

const neon = createNeonClient({ apiKey: process.env.NEON_API_KEY });
const { data } = await raw.listProjectBranchEndpoints({
  client: neon.client,
  path: {
    project_id: process.env.PROJECT_ID,
    branch_id: process.env.BRANCH_ID
  }
});

Tool: list_branch_computes

List compute endpoints for a project or branch. Do not use when you need a connection string: use get_connection_string, which requires write access and is unavailable in read-only mode.

projectId (string, optional) The ID of the project. If not provided, the only available project will be used.
branchId (string, optional) The ID of the branch. If provided, endpoints for this specific branch will be listed.

Console path: Projects → Branches → Computes

Parameters

Project ID

project_id

string

The Neon project ID

Branch ID

branch_id

string

The branch ID

Response

200

Returned a list of endpoints for the specified branch

Depth

Errors

default

General error

This endpoint can return the standard Neon API error response.

Response fields

message Required. Human-readable error message.
code Required. Machine-readable error code.
request_id Optional. Request identifier for debugging. You can provide one with the X-Request-ID header.

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.