Assign or update VPC endpoint
API Reference / Organizations / Assign or update VPC endpoint
POST /organizations//vpc/region//vpc_endpoints/
Section titled “POST /organizations//vpc/region//vpc_endpoints/”Assigns a VPC endpoint to a Neon organization or updates its existing assignment.
Parameters
Section titled “Parameters”-
org_id(string, path, required) The Neon organization ID -
region_id(string, path, required) The Neon region ID. Azure regions are currently not supported. -
vpc_endpoint_id(string, path, required) The VPC endpoint ID
Request body
Section titled “Request body”label(string, required) Human-readable name for the VPC endpoint assignment, used to identify it within the organization.
Response (200)
Section titled “Response (200)”Assigned the VPC endpoint to the specified Neon organization
Code examples
Section titled “Code examples”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"import { createNeonClient, raw } from '@neon/sdk';
const neon = createNeonClient({ apiKey: process.env.NEON_API_KEY });
const { data } = await raw.assignOrganizationVpcEndpoint({
client: neon.client,
path: {
org_id: process.env.ORG_ID,
region_id: process.env.REGION_ID,
vpc_endpoint_id: process.env.VPC_ENDPOINT_ID
}
});# neonctl
neon vpc endpoint assign <vpc_endpoint_id> --org-id <id> --region-id <region_id>Errors
Section titled “Errors”default General 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.
-
request_id(string, optional) Unique identifier for the request, useful for debugging. You can set this value manually by including anX-Request-IDheader in the request. If not provided, the value will be generated automatically. -
code(string, required) Machine-readable code classifying the error type. Seemessagefor a human-readable explanation. Default: `` -
message(string, required) Error message