Skip to main content
Neon Postgres Docs
current

Search documentation

Type to search this documentation.

On this pageOverview

Assign or update VPC endpoint

Assigns a VPC endpoint to a Neon organization or updates its existing assignment.

POST /organizations/{org_id}/vpc/region/{region_id}/vpc_endpoints/{vpc_endpoint_id}

Assigns a VPC endpoint to a Neon organization or updates its existing assignment.

Markdown for AI context

REST API - curl
curl "https://console.neon.tech/api/v2/organizations/$ORG_ID/vpc/region/$REGION_ID/vpc_endpoints/$VPC_ENDPOINT_ID" \
  -X POST \
  -H "Authorization: Bearer $NEON_API_KEY"

Also available in

Bash
neon vpc endpoint assign <vpc_endpoint_id> --org-id <id> --region-id <region_id> --region-id <region-id>

Organization

org_id

string

The Neon organization ID

Region ID

region_id

string

The Neon region ID. Azure regions are currently not supported.

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

Assigned the VPC endpoint to the specified Neon organization

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.

Suggest an edit

Propose a replacement for this page. The site team reviews it before applying any changes.

Export
Documentation menu