[metadata]
description: In Neon, the project is your main workspace. Within a project, you create branches for different workflows, like environments, features, or previews. Each branch contains its own databases, roles, com...
og:description: In Neon, the project is your main workspace. Within a project, you create branches for different workflows, like environments, features, or previews. Each branch contains its own databases, roles, com...
og:image: https://neon.com/docs/og?title=TWFuYWdlIHByb2plY3Rz&category=TWFuYWdlICYgb3BlcmF0ZQ==
og:site_name: Neon
og:title: Manage projects - Neon Docs
og:type: article
og:url: https://neon.com/docs/manage/projects
twitter:card: summary_large_image
twitter:description: In Neon, the project is your main workspace. Within a project, you create branches for different workflows, like environments, features, or previews. Each branch contains its own databases, roles, com...
twitter:image: https://neon.com/docs/og?title=TWFuYWdlIHByb2plY3Rz&category=TWFuYWdlICYgb3BlcmF0ZQ==
twitter:site: @neondatabase
twitter:title: Manage projects - Neon Docs
viewport: width=device-width, initial-scale=1, viewport-fit=cover

[canonical-links]
https://neon.com/docs/manage/projects

[document-links]
/docs
AI Gateway: /docs/ai-gateway/overview
AI agents on Neon: /docs/ai/ai-agents-tools
API keys: /docs/manage/api-keys
APIs & SDKs: /docs/reference/api
About: /about-us
Account recovery: /docs/manage/account-recovery
Accounts: /docs/manage/accounts
Active queries: /docs/introduction/monitor-active-queries
Add files to your Postgres branches via Neon Object Storage, our S3-compatible object store: https://neon.com/blog/building-neon-object-storage
Add members by domain: /docs/manage/orgs-add-members-by-domain
Apache Software Foundation: https://www.apache.org
Assign project access: /docs/manage/user-permissions#assign-project-access
Auth: /docs/auth/overview
Automate pg_dump backups: /docs/manage/backup-pg-dump-automate
Autoscaling: /docs/introduction/autoscaling
Backup & restore: /docs/guides/backup-restore
Backup & restore: /docs/manage/backups
Backup with pg_dump: /docs/manage/backup-pg-dump
Billing: https://console.neon.tech/app/billing#change_plan
Blog: /blog
Branches: /docs/manage/branches
Building on Neon: /docs/guides/platform-integration-overview
CCPA Compliant: https://trust.neon.com/?itemUid=4064ac33-7b48-407b-aed7-ce02971d1ec1
CIDR (Classless Inter-Domain Routing) notation: /docs/reference/glossary#cidr-notation
CIDR notation: /docs/reference/glossary#cidr-notation
CLI actions: /docs/manage/orgs-cli
California Privacy: https://www.databricks.com/legal/supplemental-privacy-notice-california-residents
Careers: https://www.databricks.com/company/careers/open-positions?department=engineering&location=all&itm_source=www&itm_category=company&itm_page=engineering-at-databricks&itm_location=body&itm_component=hero&itm_offer=open-positions
Changelog: /docs/changelog
Community Guides: /guides
Community: /docs/community/community-intro
Compliance Guide: /docs/security/hipaa
Computes: /docs/manage/computes
Contact Sales: /contact-sales
Create an API key: /docs/manage/api-keys#create-an-api-key
Create project: /docs/reference/api/projects/create-project
Data API documentation: /docs/data-api/get-started
Data API: /docs/data-api/overview
Database access: /docs/manage/database-access
Databases: /docs/manage/databases
Datadog: /docs/guides/datadog
Delete project: /docs/reference/api/projects/delete-project
Discord Server: https://discord.gg/92vNTzKDGp
Discord: https://discord.gg/92vNTzKDGp
Docs: /docs
Edit on GitHub: https://github.com/neondatabase/website/tree/main/content/docs/manage/projects.md
Examples repo: https://github.com/neondatabase/examples
FAQs: /faqs
GDPR Compliant: https://trust.neon.com/?itemUid=45220873-6e51-4dbb-b1b1-37d66ee9ef95
Get started: /docs/introduction
GitHub: https://github.com/neondatabase/neon
Glossary: /docs/reference/glossary
Grafana Cloud: /docs/guides/grafana-cloud
HIPAA Compliance: /docs/security/hipaa#delete-a-hipaa-compliant-project
HIPAA Compliant: /docs/security/hipaa
History window: /docs/introduction/history-window
IPv4: https://en.wikipedia.org/wiki/Internet_Protocol_version_4
IPv6: https://en.wikipedia.org/wiki/IPv6
ISO 27001 Certified: https://trust.neon.com/?itemUid=1fed9faa-4a87-427c-9a95-96b4d6bf66b7
ISO 27701 Certified: https://trust.neon.com/?itemUid=dc79cbc7-c99d-4eb9-891e-f5dc44b943d7
Instant restore: /docs/introduction/branch-restore
Integrations & tooling: /docs/guides/integrations
Integrations: /docs/manage/integrations
Learn PostgreSQL: https://neon.com/postgresql/tutorial
LinkedIn: https://www.linkedin.com/company/neon-inc/
List projects: /docs/reference/api/projects/list-projects
Log in: https://console.neon.tech/login
Logs: /docs/introduction/monitor-logs
Manage & operate: /docs/manage/platform
Manage API Keys: /docs/manage/api-keys
Manage Organizations: /docs/manage/orgs-manage
Manage branches: /docs/manage/branches
Manage computes: /docs/manage/computes
Manage organizations via API: /docs/manage/orgs-api
Metrics & logs: /docs/reference/metrics-logs
Modern Slavery Statement: https://www.databricks.com/legal/modern-slavery-policy-statement
Monitoring dashboard: /docs/introduction/monitoring-page
Multitenancy: /docs/guides/multitenancy
Neon API Reference: /docs/reference/api
Neon API Reference: /docs/reference/api/projects/create-project
Neon API Reference: /docs/reference/api/projects/delete-project
Neon API Reference: /docs/reference/api/projects/list-projects
Neon API Reference: /docs/reference/api/projects/update-project
Neon CLI commands — ip-allow: /docs/cli/ip-allow
Neon CLI — projects: /docs/cli/projects
Neon Console: https://console.neon.tech
Neon Functions: /docs/compute/functions/overview
Neon Plan: /docs/introduction/plans
Neon Platform Terms: /platform-terms
Neon plan: /docs/introduction/plans
Neon status loading...: https://neonstatus.com/
Neon: /
Neon’s Sub Contractors: /hipaa-contractors
Next Multitenancy: /docs/guides/multitenancy
Object Storage: /docs/storage/overview
Object hierarchy: /docs/manage/overview
OpenTelemetry: /docs/guides/opentelemetry
Organizations: /docs/manage/organizations
Overview: /docs/introduction/monitoring
Overview: /docs/manage/backups
Overview: /docs/manage/maintenance-updates-overview
Overview: /docs/manage/organizations
Part 1 - Create an S3 bucket: /docs/manage/backups-aws-s3-backup-part-1
Part 2 - Automate nightly backups: /docs/manage/backups-aws-s3-backup-part-2
Per-project permissions: /docs/manage/user-permissions#per-project-permissions
Permissions quickstart: /docs/manage/project-permissions-get-started
PgHero: /docs/introduction/monitor-pghero
Plans & billing: /docs/introduction/about-billing
Platform maintenance: /docs/manage/platform-maintenance
Playing with Neon: /docs/get-started/signing-up
PostgreSQL Tutorial: /postgresql/tutorial
Postgres: /docs/postgres/overview
Previous Object hierarchy: /docs/manage/overview
Privacy Notice: https://www.databricks.com/legal/privacynotice
Production checklist: /docs/get-started/production-checklist
Project collaboration guide: /docs/guides/project-collaboration-guide
Project collaboration: /docs/guides/project-collaboration-guide
Projects: /docs/manage/projects
Query organization metrics via API: /docs/manage/orgs-api-consumption
Query performance: /docs/introduction/monitor-query-performance
RSS feeds: /docs/reference/feeds
Regions: /docs/introduction/regions
Resilience & architecture: /docs/introduction/architecture-overview
Roadmap: /docs/introduction/roadmap
Roles: /docs/manage/roles
SOC 2 Certified: https://trust.neon.com/?itemUid=7bfa66da-33ab-49de-8391-e329738a1ae9
Security & compliance: /docs/security/security-overview
Security: /security
Sign up: https://console.neon.tech/signup
Startups: /startups
Status: /docs/introduction/status
Support: /docs/introduction/support
System operations: /docs/manage/operations
Tables: /docs/guides/tables
Terms of Use: https://www.databricks.com/legal/terms-of-use
Time Travel: /docs/guides/time-travel-assist
Transfer projects: /docs/manage/orgs-project-transfer
Trust Center: https://trust.neon.com
Update project: /docs/reference/api/projects/update-project
Updates: /docs/manage/updates
User permissions: /docs/manage/user-permissions
X.com: https://twitter.com/neondatabase/
YouTube: https://www.youtube.com/channel/UCoMzQTJSIr7-RU1QbomQI2w
history window: /docs/introduction/history-window
https://discord.gg/92vNTzKDGp
https://github.com/neondatabase/neon
https://neon.com/docs/llms.txt: https://neon.com/docs/llms.txt
jq: https://stedolan.github.io/jq/
logical replication guides: /docs/guides/logical-replication-guide
pgAdmin: /docs/introduction/monitor-pgadmin
request a storage increase in the feedback form in console: https://console.neon.tech/app/settings?modal=feedback&modalparams=%22Storage%20limit%20increase%22

[structured-data]
{"@context":"https://schema.org","@type":"Article","author":{"@type":"Organization","name":"Neon"},"headline":"Manage projects"}

[content]
Manage projects - Neon Docs
Add files to your Postgres branches via Neon Object Storage, our S3-compatible object store
Neon
Docs
Search
...
⌘K
Ask AI
Log in
Sign up
Get started
Products
Postgres
Auth
Data API
Neon Functions
Object Storage
AI Gateway
Platform
Manage & operate
Resilience & architecture
Security & compliance
Plans & billing
Building on Neon
AI agents on Neon
Reference
APIs & SDKs
Integrations & tooling
Glossary
Resources
Support & Community
Support
Community
Product updates
Status
Changelog
Roadmap
RSS feeds
Starter code
Examples repo
Learn PostgreSQL
Search
...
⌘K
Ask AI
Full Neon documentation index:
https://neon.com/docs/llms.txt
Manage & operate
Access & collaboration
Accounts
Permissions quickstart
User permissions
Organizations
Overview
Manage Organizations
Add members by domain
Transfer projects
Organizations API
Manage organizations via API
Query organization metrics via API
CLI
CLI actions
Project collaboration
Database access
API keys
Account recovery
Projects & resources
Object hierarchy
Projects
Multitenancy
Branches
Computes
Roles
Databases
Tables
Integrations
Monitoring & observability
Overview
Metrics & logs
Monitoring dashboard
System operations
Active queries
Query performance
Logs
Third-party monitoring
Datadog
Grafana Cloud
OpenTelemetry
pgAdmin
PgHero
Operations & maintenance
Production checklist
Backup & restore
Backup & restore
History window
Instant restore
Overview
Backup with pg_dump
Automate pg_dump backups
Part 1 - Create an S3 bucket
Part 2 - Automate nightly backups
Updates
Overview
Platform maintenance
Updates
Regions
/
Manage & operate
/
Projects
Manage projects
Learn how to manage Neon projects from the Neon Console or the Neon API.
Copy page
In Neon, the project is your main workspace. Within a project, you create branches for different workflows, like environments, features, or previews. Each branch contains its own databases, roles, computes, and replicas. Your
Neon Plan
determines how many projects you can create and the resource limits within those projects.
Default resources
When you add a new project, Neon creates the following resources by default:
A root branch is created as your project's default branch. In the Console, this branch is named
production
; via API/CLI, it's named
main
. You can create child branches for development, testing, staging, and other purposes. For more information, see
Manage branches
.
A single primary read-write compute. This is the compute associated with the branch. For more information, see
Manage computes
.
A Postgres database that resides on the project's default branch. If you did not specify your own database name when creating the project, the database created is named
neondb
.
A Postgres role that is named for your database. For example, if your database is named
neondb
, the project is created with a default role named
neondb_owner
.
Storage depends on your
Neon plan
: the Free plan includes 0.5 GB per project (shared across all branches), while paid plans (Launch and Scale) are usage-based: you pay only for what you use. Each branch on paid plans supports a logical data size of up to 16 TB. When a branch reaches this limit, write performance drops, but you can still drop or delete data to reclaim space. To increase this limit,
request a storage increase in the feedback form in console
.
Create a project
The following instructions describe how to create additional Neon projects. If you are creating your very first Neon project, refer to the instructions in
Playing with Neon
.
You can create a project from the Console or the Neon CLI. To create one with the API, see
Create a project with the API
.
Console
CLI
Navigate to the
Neon Console
.
Click
New Project
.
Specify values for
Project Name
,
Postgres version
,
Cloud service provider
, and
Region
. Project names are limited to 64 characters.
Click
Create Project
.
After creating a project, you are directed to the
Project Dashboard
.
View projects
To view your projects:
Navigate to the
Neon Console
.
From the breadcrumb navigation menu at the top-left of the console, select your organization.
The
Projects
page lists your projects, including any projects that have been shared with you.
Project settings
Once you open a project, you can use the
Settings
page to manage your project and configure any defaults.
The
Settings
page includes these sub-pages:
General
: Change the name of your project or copy the project ID.
Compute
: Set the scale to zero and sizing defaults for any new computes you create when branching.
Instant restore
: Under
Settings → Instant restore
, set the
history window
to control how far back
instant restore
, Time Travel queries, and branching from past states can reach.
Updates
: Schedule a time for Postgres and Neon updates.
Project permissions
: Grant organization members access to this project, and review who can already reach it. See
User permissions
.
Collaborators
: Invite external collaborators to join your Neon project.
Network security
: Configure Neon's IP and Private Networking features for secure access.
RLS
: Configure Neon Row-Level Security (RLS) to apply row-level security policies to your Neon project.
Logical replication
: Enable logical replication to replicate data from your Neon project to external data services and platforms.
Transfer
: Transfer your project from the current organization to another organization you belong to. Transferring a project out of an organization requires the
Admin
organization role.
Delete
: Use with care! This action deletes your entire project and all its objects, and is irreversible.
General project settings
On the
General
page, you are permitted to change the name of your project or copy the project ID. The project ID is permanent and cannot be changed.
Change your project's default compute settings
You can change your project's default compute settings on the
Compute
page. These settings determine the compute resources allocated to any new branches or read replicas you create.
important
Changes to default compute settings only affect
newly created computes
. Existing computes, including those on your primary branch and read replicas, will not be automatically updated. To change settings for existing computes, you need to update them individually through the
Branches
page.
A Compute Unit (CU) represents approximately 4 GB of RAM, along with associated CPU and local SSD resources. New branches inherit compute settings from your first branch, but you can change these defaults to:
Set smaller compute sizes for preview deployments and development branches
Standardize settings across read replicas
Optimize resource usage and costs for non-production workloads
Neon supports two compute configurations:
Fixed size:
Select a fixed compute size ranging from .25 CUs to 56 CUs
Autoscaling:
Specify minimum and maximum compute sizes (from .25 CU to 16 CUs) to automatically scale based on workload. Note: The maximum permitted autoscaling range is 8 CU, meaning the difference between max and min cannot exceed 8 CU (for example, if min = 1 CU, max can be at most 9 CU). For more information, see
Autoscaling
Configure the history window for instant restore
By default, Neon retains a history of changes for all branches in your project, enabling features like:
Instant restore
for recovering lost data
Time Travel
queries for investigating data issues
For plan limits, billing, and how retention works, see
History window
.
If you extend the history window, you expand how far back
instant restore
and Time Travel can go, but you also increase
History
usage (change history billed for instant restore) on your project.
Also note that adjusting the history window affects
all
branches in your project.
To configure the history window:
Select a project in the Neon Console.
On your
Project Dashboard
, select
Settings
.
Select
Instant restore
.
Under
History window
, use the slider to choose how long to keep change history.
Click
Save
.
Schedule updates for your project
To keep your Neon computes and Postgres instances up to date, Neon automatically applies scheduled updates that include Postgres minor version upgrades, security patches, and new features. Updates are applied to the computes within your project. They require a quick compute restart, take only a few seconds, and typically occur weekly.
On the Free plan, updates are automatically scheduled. On paid plans, you can set a preferred day and time for updates. Restarts occur within your selected time window and take only a few seconds.
To set your project's update schedule or view currently scheduled updates:
Go to
Settings
>
Updates
.
Choose a day of the week and an hour. Updates will occur within this time window and take only a few seconds.
For more information, see
Updates
.
Give someone access to a project
How you grant access depends on whether the person is already in your organization:
Organization members
: Grant them a per-project permission (
Viewer
,
Editor
, or
Admin
) from the project's
Settings
→
Project permissions
page. This is also how you give a member more access on one project than their organization role provides. See
Assign project access
.
People outside your organization
: Invite them as a collaborator, as described below.
Invite collaborators to a project
Neon's project collaboration feature allows you to invite external Neon accounts to collaborate on a Neon project.
note
Project sharing is being deprecated and will be removed in a future release. To give a contractor or other limited-access user access to specific projects, add them to the organization as a
Collaborator
and grant per-project permissions instead. See
User permissions
.
Organization members can't be added as collaborators on organization-owned projects. Grant them a per-project permission instead.
To invite collaborators to a Neon project:
In the Neon Console, select a project.
Select
Settings
.
Select
Collaborators
.
Select
Invite
and enter the email address of the account you want to collaborate with.
Click
Invite
.
The email you specify is added to the list of
Collaborators
. The Neon account associated with that email address is granted full access to the project, with the exception of privileges required to delete the project. This account can also invite other Neon users to the project. When that user logs in to Neon, the project they were invited to is listed on their
Projects
page under
Shared with you
.
The costs associated with projects being collaborated on are charged to the Neon account that owns the project. For example, if you invite another Neon user account to a project you own, any usage incurred by that user within your project is billed to your Neon account, not theirs.
For additional information, refer to our
Project collaboration guide
.
Configure IP Allow
The IP Allow feature provides an added layer of security for your data, restricting access to the branch where your database resides to only those IP addresses that you specify. In Neon, the IP allowlist is applied to all branches by default.
Optionally, you can allow unrestricted access to your project's non-protected branches. For instance, you might want to restrict access to protected branches to a handful of trusted IPs while allowing unrestricted access to your development branches.
By default, Neon allows IP addresses from
0.0.0.0
, which means that Neon accepts connections from any IP address. Once you configure IP Allow by adding IP addresses or ranges, only those IP addresses will be allowed to access Neon.
note
Neon projects provisioned on AWS support both
IPv4
and
IPv6
addresses. Neon project provisioned on Azure currently on support IPv4.
Neon Console
CLI
API
To configure an allowlist:
Select a project in the Neon Console.
On the
Project Dashboard
, select
Settings
.
Select
Network security
.
Under
IP Allow
, specify the IP addresses you want to permit. Separate multiple entries with commas.
Optionally, under
Branch access
, select
Restrict IP Access to protected branches only
to restrict access to only the branches you have designated as protected.
Click
Save changes
.
How to specify IP addresses
You can define an allowlist with individual IP addresses, IP ranges, or
CIDR notation
. A combination of these options is also permitted. Multiple entries, whether they are the same or of different types, must be separated by a comma. Whitespace is ignored.
Add individual IP addresses
: You can add individual IP addresses that you want to allow. This is useful for granting access to specific users or devices. This example represents a single IP address:
192.0.2.1
Define IP ranges
: For broader access control, you can define IP ranges. This is useful for allowing access from a company network or a range of known IPs. This example range includes all IP addresses from
198.51.100.20
to
198.51.100.50
:
198.51.100.20-198.51.100.50
Use CIDR notation
: For more advanced control, you can use
CIDR (Classless Inter-Domain Routing) notation
. This is a compact way of defining a range of IPs and is useful for larger networks or subnets. Using CIDR notation can be advantageous when managing access to branches with numerous potential users, such as in a large development team or a company-wide network.
This CIDR notation example represents all 256 IP addresses from
203.0.113.0
to
203.0.113.255
.
203.0.113.0/24
Use IPv6 addresses
: Neon projects provisioned on AWS also support specifying IPv6 addresses. For example:
note
IPv6 is not yet supported for projects provisioned on Azure.
2001:DB8:5432::/48
A combined example using all three options above, specified as a comma-separated list, would appear similar to the following:
192.0.2.1, 198.51.100.20-198.51.100.50, 203.0.113.0/24, 2001:DB8:5432::/48
This list combines individual IP addresses, a range of IP addresses, a CIDR block, and an IPv6 address. It illustrates how different types of IP specifications can be used together in a single allowlist configuration, offering a flexible approach to access control.
Update an IP Allow configuration
You can update your IP Allow configuration via the Neon Console or API as described in
Configure IP Allow
. Replace the current configuration with the new configuration. For example, if your IP Allow configuration currently allows access from IP address
192.0.2.1
, and you want to extend access to IP address
192.0.2.2
, specify both addresses in your new configuration:
192.0.2.1, 192.0.2.2
. You cannot append values to an existing configuration. You can only replace an existing configuration with a new one.
The Neon CLI provides an
ip-allow
command with
add
,
reset
, and
remove
options that you can use to update your IP Allow configuration. For instructions, refer to
Neon CLI commands — ip-allow
.
Remove an IP Allow configuration
To remove an IP configuration entirely to go back to the default "no IP restrictions" (
0.0.0.0
) configuration:
Neon Console
CLI
API
Select a project in the Neon Console.
On the
Project Dashboard
, select
Settings
.
Select
IP Allow
.
Clear the
Allowed IP addresses and ranges
field.
If applicable, clear the
Restrict IP Access to protected branches only
checkbox.
Click
Save changes
.
Enable the Data API
The Data API turns your database tables into a REST API, making it easy to query your data from client applications. When you enable the Data API, it automatically creates
authenticated
and
anonymous
roles and sets up the necessary permissions for secure client-side access.
For setup instructions and examples, see the
Data API documentation
.
Enable logical replication
Logical replication lets you replicate data changes from Neon to external data services and platforms, including data warehouses, analytical database services, messaging platforms, event-streaming platforms, and external Postgres databases.
important
Enabling logical replication changes the PostgreSQL
wal_level
setting from
replica
to
logical
for all databases in your Neon project. This allows Postgres to record the row-level WAL detail required for logical decoding. Once changed, it cannot be reverted. Enabling logical replication also restarts all computes, so active connections will be dropped and have to reconnect.
Console
API
Select your project in the Neon Console.
On the
Project Dashboard
, select
Settings
.
Select
Logical replication
.
Click
Enable
to enable logical replication.
You can verify that logical replication is enabled by running the following query:
SHOW wal_level;
wal_level
-----------
logical
After enabling logical replication, the next steps involve creating publications on your replication source database in Neon and configuring subscriptions on the destination system or service. To get started, refer to our
logical replication guides
.
Delete a project
Deleting a project is a permanent action, which also deletes any computes, branches, databases, and roles that belong to the project.
Deleting a project requires
Admin
access on that project, which every organization Admin has. A member granted Admin on a single project can delete that project. See
Per-project permissions
.
To delete a project:
Navigate to the
Neon Console
.
Select the project that you want to delete.
Select
Settings
.
Select
Delete
.
note
For HIPAA-compliant projects, see
HIPAA Compliance
before deleting a project—for example, to export audit logs you may need.
important
If you are any of Neon's paid plans, deleting all your Neon projects won't stop monthly billing. To avoid charges, you also need to downgrade to the Free plan. You can do so from the
Billing
page in the Neon Console.
note
Deleted projects can be recovered within the deletion recovery period (7 days) via the API or CLI. For details, see
Recover a deleted project
.
Manage projects with the Neon API
Project actions performed in the Neon Console can also be performed using the Neon API. The following examples demonstrate how to create, view, and delete projects using the Neon API. For other project-related API methods, refer to the
Neon API Reference
.
note
The API examples that follow may not show all of the user-configurable request body attributes that are available to you. To view all attributes for a particular method, refer to method's request body schema in the
Neon API Reference
.
The
jq
option specified in each example is an optional third-party tool that formats the
JSON
response, making it easier to read. For information about this utility, see
jq
.
Prerequisites
A Neon API request requires an API key. For information about obtaining an API key, see
Create an API key
. In the cURL examples shown below,
$NEON_API_KEY
is specified in place of an actual API key, which you must provide when making a Neon API request.
note
To learn more about the types of API keys you can create — personal, organization, or project-scoped — see
Manage API Keys
.
Create a project with the API
The following Neon API method creates a project. To view the API documentation for this method, refer to the
Neon API Reference
.
POST
/projects
The API method appears as follows when specified in a cURL command. The
myproject
name value is a user-specified name for the project.
curl
'https://console.neon.tech/api/v2/projects'
\
-H
'Accept: application/json'
\
-H
"Authorization: Bearer $NEON_API_KEY"
\
-H
'Content-Type: application/json'
\
-d
'{
"project": {
"name": "myproject"
}
}'
|
jq
The response includes information about the role, the database, the default branch, and the primary read-write compute that is created with the project.
Response body
For attribute definitions, find the
Create project
endpoint in the
Neon API Reference
. Definitions are provided in the
Responses
section.
{
"project"
:
{
"data_storage_bytes_hour"
:
0
,
"data_transfer_bytes"
:
0
,
"written_data_bytes"
:
0
,
"compute_time_seconds"
:
0
,
"active_time_seconds"
:
0
,
"cpu_used_sec"
:
0
,
"id"
:
"ep-cool-darkness-123456"
,
"platform_id"
:
"aws"
,
"region_id"
:
"aws-us-east-1"
,
"name"
:
"myproject"
,
"provisioner"
:
"k8s-neonvm"
,
"default_endpoint_settings"
:
{
"autoscaling_limit_min_cu"
:
0.25
,
"autoscaling_limit_max_cu"
:
0.25
,
"suspend_timeout_seconds"
:
0
}
,
"settings"
:
{
"allowed_ips"
:
{
"ips"
:
[]
,
"protected_branches_only"
:
false
}
,
"enable_logical_replication"
:
false
,
"maintenance_window"
:
{
"weekdays"
:
[
7
]
,
"start_time"
:
"06:00"
,
"end_time"
:
"07:00"
}
,
"block_public_connections"
:
false
,
"block_vpc_connections"
:
false
,
"hipaa"
:
false
}
,
"pg_version"
:
17
,
"proxy_host"
:
"c-2.us-east-1.aws.neon.tech"
,
"branch_logical_size_limit"
:
512
,
"branch_logical_size_limit_bytes"
:
536870912
,
"store_passwords"
:
true
,
"creation_source"
:
"console"
,
"history_retention_seconds"
:
86400
,
"created_at"
:
"2025-08-04T05:15:41Z"
,
"updated_at"
:
"2025-08-04T05:15:41Z"
,
"consumption_period_start"
:
"0001-01-01T00:00:00Z"
,
"consumption_period_end"
:
"0001-01-01T00:00:00Z"
,
"owner_id"
:
"91cbdacd-06c2-49f5-bacf-78b9463c81ca"
}
,
"connection_uris"
:
[
{
"connection_uri"
:
"postgresql://alex:AbC123dEf@ep-cool-darkness-123456.c-2.us-east-1.aws.neon.tech/dbname?sslmode=require&channel_binding=require"
,
"connection_parameters"
:
{
"database"
:
"dbname"
,
"password"
:
"AbC123dEf"
,
"role"
:
"alex"
,
"host"
:
"ep-cool-darkness-123456.c-2.us-east-1.aws.neon.tech"
,
"pooler_host"
:
"ep-cool-darkness-123456-pooler.c-2.us-east-1.aws.neon.tech"
}
}
]
,
"roles"
:
[
{
"branch_id"
:
"br-gentle-salad-ad7v90qq"
,
"name"
:
"neondb_owner"
,
"password"
:
"npg_Se0ECYqaJ5jA"
,
"protected"
:
false
,
"created_at"
:
"2025-08-04T05:15:41Z"
,
"updated_at"
:
"2025-08-04T05:15:41Z"
}
]
,
"databases"
:
[
{
"id"
:
5140981
,
"branch_id"
:
"br-gentle-salad-ad7v90qq"
,
"name"
:
"neondb"
,
"owner_name"
:
"neondb_owner"
,
"created_at"
:
"2025-08-04T05:15:41Z"
,
"updated_at"
:
"2025-08-04T05:15:41Z"
}
]
,
"operations"
:
[
{
"id"
:
"cacca1d4-ad0e-46dc-ae82-886ffb96889d"
,
"project_id"
:
"ep-cool-darkness-123456"
,
"branch_id"
:
"br-gentle-salad-ad7v90qq"
,
"action"
:
"create_timeline"
,
"status"
:
"running"
,
"failures_count"
:
0
,
"created_at"
:
"2025-08-04T05:15:41Z"
,
"updated_at"
:
"2025-08-04T05:15:41Z"
,
"total_duration_ms"
:
0
}
,
{
"id"
:
"1df43d11-5c07-4de1-9440-ac09d305fdf3"
,
"project_id"
:
"ep-cool-darkness-123456"
,
"branch_id"
:
"br-gentle-salad-ad7v90qq"
,
"endpoint_id"
:
"ep-cool-darkness-123456"
,
"action"
:
"start_compute"
,
"status"
:
"scheduling"
,
"failures_count"
:
0
,
"created_at"
:
"2025-08-04T05:15:41Z"
,
"updated_at"
:
"2025-08-04T05:15:41Z"
,
"total_duration_ms"
:
0
}
]
,
"branch"
:
{
"id"
:
"br-gentle-salad-ad7v90qq"
,
"project_id"
:
"ep-cool-darkness-123456"
,
"name"
:
"main"
,
"current_state"
:
"init"
,
"pending_state"
:
"ready"
,
"state_changed_at"
:
"2025-08-04T05:15:41Z"
,
"creation_source"
:
"console"
,
"primary"
:
true
,
"default"
:
true
,
"protected"
:
false
,
"cpu_used_sec"
:
0
,
"compute_time_seconds"
:
0
,
"active_time_seconds"
:
0
,
"written_data_bytes"
:
0
,
"data_transfer_bytes"
:
0
,
"created_at"
:
"2025-08-04T05:15:41Z"
,
"updated_at"
:
"2025-08-04T05:15:41Z"
,
"init_source"
:
"parent-data"
}
,
"endpoints"
:
[
{
"host"
:
"ep-cool-darkness-123456.c-2.us-east-1.aws.neon.tech"
,
"id"
:
"ep-cool-darkness-123456"
,
"project_id"
:
"ep-cool-darkness-123456"
,
"branch_id"
:
"br-gentle-salad-ad7v90qq"
,
"autoscaling_limit_min_cu"
:
0.25
,
"autoscaling_limit_max_cu"
:
0.25
,
"region_id"
:
"aws-us-east-1"
,
"type"
:
"read_write"
,
"current_state"
:
"init"
,
"pending_state"
:
"active"
,
"settings"
:
{}
,
"pooler_enabled"
:
false
,
"pooler_mode"
:
"transaction"
,
"disabled"
:
false
,
"passwordless_access"
:
true
,
"creation_source"
:
"console"
,
"created_at"
:
"2025-08-04T05:15:41Z"
,
"updated_at"
:
"2025-08-04T05:15:41Z"
,
"proxy_host"
:
"c-2.us-east-1.aws.neon.tech"
,
"suspend_timeout_seconds"
:
0
,
"provisioner"
:
"k8s-neonvm"
}
]
}
List projects with the API
The following Neon API method lists projects for your Neon account. To view the API documentation for this method, refer to the
Neon API Reference
.
GET
/projects
The API method appears as follows when specified in a cURL command:
curl
'https://console.neon.tech/api/v2/projects'
\
-H
'Accept: application/json'
\
-H
"Authorization: Bearer $NEON_API_KEY"
|
jq
Response body
For attribute definitions, find the
List projects
endpoint in the
Neon API Reference
. Definitions are provided in the
Responses
section.
{
"projects"
:
[
{
"id"
:
"frosty-tree-10754091"
,
"platform_id"
:
"aws"
,
"region_id"
:
"aws-ap-southeast-1"
,
"name"
:
"personal_projects"
,
"provisioner"
:
"k8s-neonvm"
,
"default_endpoint_settings"
:
{
"autoscaling_limit_min_cu"
:
0.25
,
"autoscaling_limit_max_cu"
:
2
,
"suspend_timeout_seconds"
:
0
}
,
"settings"
:
{
"allowed_ips"
:
{
"ips"
:
[]
,
"protected_branches_only"
:
false
}
,
"enable_logical_replication"
:
false
,
"maintenance_window"
:
{
"weekdays"
:
[
4
]
,
"start_time"
:
"15:00"
,
"end_time"
:
"16:00"
}
,
"block_public_connections"
:
false
,
"block_vpc_connections"
:
false
,
"hipaa"
:
false
}
,
"pg_version"
:
17
,
"proxy_host"
:
"ap-southeast-1.aws.neon.tech"
,
"branch_logical_size_limit"
:
512
,
"branch_logical_size_limit_bytes"
:
536870912
,
"store_passwords"
:
true
,
"active_time"
:
1260
,
"cpu_used_sec"
:
319
,
"creation_source"
:
"console"
,
"created_at"
:
"2024-11-08T17:20:01Z"
,
"updated_at"
:
"2025-08-03T01:16:18Z"
,
"synthetic_storage_size"
:
96929448
,
"quota_reset_at"
:
"2025-09-01T00:00:00Z"
,
"owner_id"
:
"91cbdacd-06c2-49f5-bacf-78b9463c81ca"
,
"compute_last_active_at"
:
"2025-08-03T01:16:18Z"
,
"history_retention_seconds"
:
86400
}
,
{
"id"
:
"lingering-grass-54827563"
,
"platform_id"
:
"aws"
,
"region_id"
:
"aws-ap-southeast-1"
,
"name"
:
"brizai"
,
"provisioner"
:
"k8s-neonvm"
,
"default_endpoint_settings"
:
{
"autoscaling_limit_min_cu"
:
0.25
,
"autoscaling_limit_max_cu"
:
2
,
"suspend_timeout_seconds"
:
0
}
,
"settings"
:
{
"allowed_ips"
:
{
"ips"
:
[]
,
"protected_branches_only"
:
false
}
,
"enable_logical_replication"
:
false
,
"maintenance_window"
:
{
"weekdays"
:
[
1
]
,
"start_time"
:
"16:00"
,
"end_time"
:
"17:00"
}
,
"block_public_connections"
:
false
,
"block_vpc_connections"
:
false
,
"hipaa"
:
false
}
,
"pg_version"
:
17
,
"proxy_host"
:
"ap-southeast-1.aws.neon.tech"
,
"branch_logical_size_limit"
:
512
,
"branch_logical_size_limit_bytes"
:
536870912
,
"store_passwords"
:
true
,
"active_time"
:
0
,
"cpu_used_sec"
:
0
,
"creation_source"
:
"console"
,
"created_at"
:
"2024-10-28T16:26:49Z"
,
"updated_at"
:
"2025-08-01T00:34:48Z"
,
"synthetic_storage_size"
:
31082816
,
"quota_reset_at"
:
"2025-09-01T00:00:00Z"
,
"owner_id"
:
"91cbdacd-06c2-49f5-bacf-78b9463c81ca"
,
"compute_last_active_at"
:
"2025-02-14T09:51:30Z"
,
"history_retention_seconds"
:
86400
}
]
,
"unavailable_project_ids"
:
[]
,
"pagination"
:
{
"cursor"
:
"lingering-grass-54827563"
}
,
"applications"
:
{
"frosty-tree-10754091"
:
[
"vercel"
]
}
,
"integrations"
:
{
"frosty-tree-10754091"
:
[
"vercel"
]
}
}
Update a project with the API
The following Neon API method updates the specified project. To view the API documentation for this method, refer to the
Neon API Reference
.
PATCH
/projects/{project_id}
The API method appears as follows when specified in a cURL command. The
project_id
is a required parameter. The example changes the project
name
to
project1
.
curl
-X
PATCH
'https://console.neon.tech/api/v2/projects/ep-cool-darkness-123456'
\
-H
'accept: application/json'
\
-H
"Authorization: Bearer $NEON_API_KEY"
\
-H
'Content-Type: application/json'
\
-d
'{
"project": {
"name": "project1"
}
}'
Response body
For attribute definitions, find the
Update project
endpoint in the
Neon API Reference
. Definitions are provided in the
Responses
section.
{
"project"
:
{
"data_storage_bytes_hour"
:
35697544
,
"data_transfer_bytes"
:
13444
,
"written_data_bytes"
:
34595496
,
"compute_time_seconds"
:
89
,
"active_time_seconds"
:
348
,
"cpu_used_sec"
:
89
,
"id"
:
"ep-cool-darkness-123456"
,
"platform_id"
:
"aws"
,
"region_id"
:
"aws-us-east-1"
,
"name"
:
"project1"
,
"provisioner"
:
"k8s-neonvm"
,
"default_endpoint_settings"
:
{
"autoscaling_limit_min_cu"
:
0.25
,
"autoscaling_limit_max_cu"
:
0.25
,
"suspend_timeout_seconds"
:
0
}
,
"settings"
:
{
"allowed_ips"
:
{
"ips"
:
[]
,
"protected_branches_only"
:
false
}
,
"enable_logical_replication"
:
false
,
"maintenance_window"
:
{
"weekdays"
:
[
7
]
,
"start_time"
:
"06:00"
,
"end_time"
:
"07:00"
}
,
"block_public_connections"
:
false
,
"block_vpc_connections"
:
false
,
"hipaa"
:
false
}
,
"pg_version"
:
17
,
"proxy_host"
:
"c-2.us-east-1.aws.neon.tech"
,
"branch_logical_size_limit"
:
512
,
"branch_logical_size_limit_bytes"
:
536870912
,
"store_passwords"
:
true
,
"creation_source"
:
"console"
,
"history_retention_seconds"
:
86400
,
"created_at"
:
"2025-08-04T05:15:41Z"
,
"updated_at"
:
"2025-08-04T05:55:58Z"
,
"synthetic_storage_size"
:
35697544
,
"consumption_period_start"
:
"0001-01-01T00:00:00Z"
,
"consumption_period_end"
:
"0001-01-01T00:00:00Z"
,
"owner_id"
:
"91cbdacd-06c2-49f5-bacf-78b9463c81ca"
,
"compute_last_active_at"
:
"2025-08-04T05:15:47Z"
}
,
"operations"
:
[]
}
Delete a project with the API
The following Neon API method deletes the specified project. To view the API documentation for this method, refer to the
Neon API Reference
.
DELETE
/projects/{project_id}
The API method appears as follows when specified in a cURL command. The
project_id
is a required parameter.
curl
-X
'DELETE'
\
'https://console.neon.tech/api/v2/projects/ep-cool-darkness-123456'
\
-H
'accept: application/json'
\
-H
"Authorization: Bearer $NEON_API_KEY"
Response body
For attribute definitions, find the
Delete project
endpoint in the
Neon API Reference
. Definitions are provided in the
Responses
section.
{
"project"
:
{
"data_storage_bytes_hour"
:
35697544
,
"data_transfer_bytes"
:
13444
,
"written_data_bytes"
:
34595496
,
"compute_time_seconds"
:
89
,
"active_time_seconds"
:
348
,
"cpu_used_sec"
:
89
,
"id"
:
"ep-cool-darkness-123456"
,
"platform_id"
:
"aws"
,
"region_id"
:
"aws-us-east-1"
,
"name"
:
"project2"
,
"provisioner"
:
"k8s-neonvm"
,
"default_endpoint_settings"
:
{
"autoscaling_limit_min_cu"
:
0.25
,
"autoscaling_limit_max_cu"
:
0.25
,
"suspend_timeout_seconds"
:
0
}
,
"settings"
:
{
"allowed_ips"
:
{
"ips"
:
[]
,
"protected_branches_only"
:
false
}
,
"enable_logical_replication"
:
false
,
"maintenance_window"
:
{
"weekdays"
:
[
7
]
,
"start_time"
:
"06:00"
,
"end_time"
:
"07:00"
}
,
"block_public_connections"
:
false
,
"block_vpc_connections"
:
false
,
"hipaa"
:
false
}
,
"pg_version"
:
17
,
"proxy_host"
:
"c-2.us-east-1.aws.neon.tech"
,
"branch_logical_size_limit"
:
512
,
"branch_logical_size_limit_bytes"
:
536870912
,
"store_passwords"
:
true
,
"creation_source"
:
"console"
,
"history_retention_seconds"
:
86400
,
"created_at"
:
"2025-08-04T05:15:41Z"
,
"updated_at"
:
"2025-08-04T06:10:55Z"
,
"synthetic_storage_size"
:
35697544
,
"consumption_period_start"
:
"0001-01-01T00:00:00Z"
,
"consumption_period_end"
:
"0001-01-01T00:00:00Z"
,
"owner_id"
:
"91cbdacd-06c2-49f5-bacf-78b9463c81ca"
,
"compute_last_active_at"
:
"2025-08-04T05:15:47Z"
}
}
Recover a deleted project
If you accidentally delete a project, you can recover it within 7 days. This
deletion recovery period
allows you to restore deleted projects with all their data and configuration intact.
note
The deletion recovery period is different from the
history window
used for
instant restore
on branch data. The history window enables point-in-time recovery (PITR) for branch data, while the deletion recovery period allows you to recover (undelete) an entire deleted project.
What's recovered
When you recover a deleted project, the following are restored:
All branches, endpoints, snapshots, and compute configurations
Project settings (IP Allow, logical replication, protected branches, scheduled updates)
Project collaborators
Connection strings
Vercel-Managed Neon integration projects are re-imported into Vercel for management and billing
What requires reconfiguration
The following features are
not
recovered and must be manually re-enabled after recovery:
Data API
(including
authenticated
and
anonymous
roles)
GitHub integration
Neon-Managed Vercel integration
(Vercel Connected Accounts)
Vercel-Managed Neon integration
(project reconnection via Storage)
Monitoring integrations
(Datadog, OpenTelemetry, etc.)
Costs
There are no storage costs or recovery fees during the 7-day deletion recovery period.
Recover a project
CLI
API
To list projects that can be recovered:
neon
projects
list
--recoverable-only
To recover a deleted project:
neon
projects
recover
<project_id>
The command returns details about the recovered project.
Example:
neon
projects
recover
crimson-voice-12345678
┌────────────────────────┬───────────┬───────────────┬──────────────────────┐
│
Id
│
Name
│
Region
Id
│
Created
At
│
├────────────────────────┼───────────┼───────────────┼──────────────────────┤
│
crimson-voice-12345678
│
myproject
│
aws-us-east-2
│
2024-04-15T11:17:30Z
│
└────────────────────────┴───────────┴───────────────┴──────────────────────┘
For more information about the Neon CLI, see
Neon CLI — projects
.
Need help?
Join our
Discord Server
to ask questions or see what others are doing with Neon. For paid plan support options, see
Support
.
Was this page helpful?
Yes
No
Thank you for your feedback!
Edit on GitHub
Previous
Object hierarchy
Next
Multitenancy
On this page
Default resources
Create a project
View projects
Project settings
Manage projects with the Neon API
Recover a deleted project
Need help?
Set up Neon with AI
Copy neon init command
Neon Docs
Neon
Neon is part of the Databricks Platform
Neon status loading...
© Neon 2026. All rights reserved. Apache, Apache Spark, Spark, the Spark Logo, Apache Iceberg, Iceberg, and the Apache Iceberg logo are trademarks of the
Apache Software Foundation
.
Privacy Notice
Terms of Use
Neon Platform Terms
Modern Slavery Statement
California Privacy
Company
About
Blog
Careers
Contact Sales
Security
Resources
Docs
Changelog
Support
Community Guides
FAQs
PostgreSQL Tutorial
Startups
Community
Discord
GitHub
X.com
LinkedIn
YouTube
Compliance
CCPA
Compliant
GDPR
Compliant
ISO 27001
Certified
ISO 27701
Certified
SOC 2
Certified
HIPAA
Compliant
Compliance Guide
Neon’s Sub Contractors
Trust Center
