Retrieve VPC endpoint details

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

Retrieves the current state and configuration details of a specified VPC endpoint.

Markdown for AI context

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

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

Also available in

neon vpc endpoint status <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

200

Returned the current status and configuration details of the specified VPC endpoint.

Depth

"vpc_endpoint_id": (string),req

"label": (string),req

"state": (string),req

"num_restricted_projects": (integer),req

"example_restricted_projects": (array),req

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.