neon-api-endpoints

Overview

This section provides rules for managing compute endpoints associated with branches in a project. Compute endpoints are Neon compute instances that allow you to connect to and interact with your databases.

Manage compute endpoints

Create compute endpoint

1. Action: Creates a new compute endpoint (a Neon compute instance) and associates it with a specified branch.
2. Endpoint: POST /projects/{project_id}/endpoints
3. Path Parameters:
   • project_id (string, required): The unique identifier of the project.
4. Body Parameters: endpoint (object, required): The container for the new endpoint's properties.
   • branch_id (string, required): The ID of the branch to associate the endpoint with.
   • type (string, required): The endpoint type. A branch can have only one read_write endpoint but multiple read_only endpoints. Allowed values: read_write, read_only.
   • region_id (string, optional): The region where the endpoint will be created. Must match the project's region.
   • autoscaling_limit_min_cu (number, optional): The minimum number of Compute Units (CU). Minimum 0.25.
   • autoscaling_limit_max_cu (number, optional): The maximum number of Compute Units (CU). Minimum 0.25.
   • provisioner (string, optional): The compute provisioner. Specify k8s-neonvm to enable Autoscaling. Allowed values: k8s-pod, k8s-neonvm.
   • suspend_timeout_seconds (integer, optional): Duration of inactivity in seconds before suspending the compute. Ranges from -1 (never suspend) to 604800 (1 week).
   • disabled (boolean, optional): If true, restricts connections to the endpoint.

Example Request:

curl 'https://console.neon.tech/api/v2/projects/hidden-river-50598307/endpoints' \
  -H 'Accept: application/json' \
  -H "Authorization: Bearer $NEON_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
  "endpoint": {
    "branch_id": "br-your-branch-id",
    "type": "read_only"
  }
}'

Example Response: