Set VPC endpoint restriction

POST /projects/{project_id}/vpc_endpoints/{vpc_endpoint_id}

Sets or updates a VPC endpoint restriction for a Neon project. When a VPC endpoint restriction is set, the project only accepts connections from the specified VPC. A VPC endpoint can be set as a restriction only after it is assigned to the parent organization of the Neon project.

Markdown for AI context

curl "https://console.neon.tech/api/v2/projects/$PROJECT_ID/vpc_endpoints/$VPC_ENDPOINT_ID" \
  -X POST \
  -H "Authorization: Bearer $NEON_API_KEY"

Also available in

neon vpc project restrict <vpc_endpoint_id> --project-id <id>

Project ID

project_id

string

The Neon project ID

VPC endpoint ID

vpc_endpoint_id

string

The VPC endpoint ID

1 required Required: label.

Label

label

string

Human-readable name for the VPC endpoint assignment, used to identify it within the organization.

200

Configured the specified VPC endpoint as a restriction for the specified project.

No example available.

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.