Neon CLI commands — vpc
Use the Neon CLI to manage Neon directly from the terminal
Before you begin
- Before running a
vpccommand, ensure that you have installed the Neon CLI. - If you have not authenticated with the neon auth command, running a Neon CLI command automatically launches the Neon CLI browser authentication process. Alternatively, you can specify a Neon API key using the
--api-keyoption when running a command. See Connect.
The vpc command
The vpc command is the primary command for managing Virtual Private Cloud (VPC) configurations within Neon. It serves as a parent command to manage VPC endpoints and project-specific restrictions.
The vpc command includes subcommands for both organization-level and project-level VPC management:
| Subcommand | Description |
|---|---|
| endpoint | Manage VPC endpoints for Neon Private Networking. |
| project | Manage VPC endpoint restrictions at the project level. |
The vpc endpoint subcommand
The vpc endpoint command enables management of VPC endpoints for Neon Private Networking configurations.
Usage
The vpc endpoint subcommand allows you to list, assign, remove, and get the status of VPC endpoints for a Neon organization.
| Subcommand | Description |
|---|---|
| list | List configured VPC endpoints for this organization. |
| assign | Add or update a VPC endpoint for this organization. |
Note: Azure regions are not yet supported. [Aliases: update, add] | |
| remove | Remove a VPC endpoint from this organization. |
| status | Get the status of a VPC endpoint for this organization. |
Options
In addition to the Neon CLI global options, the vpc endpoint subcommand supports these options:
| Option | Description | Type | Required |
|---|---|---|---|
--org-id | Organization ID | string | Only if the user has more than on organization. If not specified, and the user has only one organization, that org_id is used. |
--region-id | The region ID. Possible values: aws-us-west-2, aws-ap-southeast-1, aws-ap-southeast-2, aws-eu-central-1, aws-us-east-2, aws-us-east-1, azure-eastus2 | string | yes |
Examples
-
List VPC endpoints
Retrieve a list of all configured VPC endpoints for a specific organization.
neonctl vpc endpoint list --org-id my-org-id -
Assign a VPC endpoint
Add or update a VPC endpoint for a specific organization and region.
neonctl vpc endpoint assign vpc-12345678 --org-id my-org-id --region-id aws-us-east-1 -
Remove a VPC endpoint
Delete an existing VPC endpoint from a specific organization.
neonctl vpc endpoint remove vpc-12345678 --org-id my-org-id -
Get the status of a VPC endpoint
Check the status of a specific VPC endpoint in an organization.
neonctl vpc endpoint status vpc-12345678 --org-id my-org-id
The vpc project subcommand
The vpc project subcommand allows you to manage project-level VPC endpoint restrictions in your Neon organization.
Usage
The vpc project command enables you to list, configure, update, or remove VPC endpoint restrictions for specific Neon projects.
| Subcommand | Description |
|---|---|
| list | List all VPC endpoint restrictions for a specific project. |
| restrict | Configure or update a VPC endpoint restriction for a project. [Alias: update] |
| remove | Remove a VPC endpoint restriction from a project. |
Options
In addition to the Neon CLI global options, the vpc project subcommand supports these options:
| Option | Description | Type | Required |
|---|---|---|---|
--project-id | The Project ID. | string | yes |
Examples
-
List project-level VPC endpoint restrictions
Retrieve a list of all VPC endpoint restrictions for a specific project.
neonctl vpc project list --project-id my-project-id -
Restrict connections to a specific VPC
Configure or update a VPC endpoint restriction for a project.
neonctl vpc project restrict vpc-12345678 --project-id my-project-id -
Remove a VPC endpoint restriction Remove a VPC endpoint restriction from a specific project.
neonctl vpc project remove vpc-12345678 --project-id my-project-id
Need help?
Join our Discord Server to ask questions or see what others are doing with Neon. Users on paid plans can open a support ticket from the console. For more details, see Getting Support.