Reference

Create New API Key

Generate a new API key for your Neon account to enable programmatic access to your database services across different applications and environments. Store the returned key securely immediately after creation as it won't be shown again.

Create API Key for Organization

Generate a new API key for your Neon organization to enable programmatic access to your database infrastructure and automate workflows. Store the key securely immediately after creation as it won't be retrievable later.

Delete api key by id

Revokes access for a specific API key, immediately preventing any applications or services from using it to connect to your Neon account. Use this when you need to disable access due to security concerns or changes in your team.

Delete organization api key

Revokes access for a specific API key in your Neon organization, preventing it from being used to access your database infrastructure. Use this to remove compromised keys, rotate credentials for security, or clean up unused access tokens.

Get organization api keys

Retrieve all API keys associated with your organization to review active access credentials and manage who can connect to your services.

List api keys

View all API keys linked to your Neon account to monitor active integrations and audit which keys are currently in use.

Add new jwks to project endpoint

Configure JWT-based authentication for your Neon database by adding a JSON Web Key Set URL from an identity provider, enabling secure token verification for database access.

Create Auth Provider SDK Keys

Generates SDK and API keys needed to integrate authentication providers like Stack Auth or Better Auth into your Neon project. This enables secure user login and identity management for your application.

Create auth user

Creates a new authentication user in your Neon database branch, allowing you to set up login credentials for application access. This is essential for managing who can authenticate and access your application's data.

Delete auth domain from project

Removes an authorized redirect domain from your project's authentication whitelist, preventing it from being used as a valid redirect URI. Use this when you need to revoke access permissions for a specific domain.

Delete auth domains

Remove domains from your authentication whitelist to prevent unauthorized access from specific locations or deactivate login paths you no longer need.

Delete auth user

Permanently removes a user's access to authenticate on a specific database branch in your Neon project. Use this when team members leave or no longer need access to particular environments.

Delete OAuth provider

Removes an OAuth provider configuration (such as Google, GitHub, or Vercel) from a specific database branch, disabling that authentication method for users on that branch. Use this to revoke OAuth access or clean up authentication settings when you no longer need a particular sign-in provider.

Delete project jwks by id

Removes a JSON Web Key Set from your Neon project to clean up outdated authentication credentials or rotate security keys. This is useful when decommissioning integrations or maintaining security hygiene.

Disable branches auth

Removes authentication integration from a specific database branch in your Neon project, with the option to delete associated authentication data. Use this when you need to disable auth requirements for a branch or clean up unused authentication configurations.

Enable Neon Auth for branch

Enables Neon Auth for a specific branch, allowing you to set up secure authentication and user management for that branch without affecting other branches in your project.

Get auth

Retrieve details about your current API credentials and authenticated account to verify which authentication method is active for your requests.

Get auth allow localhost

Checks whether localhost connections are permitted for a specific database branch in your Neon project, helping you verify your local development environment configuration.

Get auth email provider

Check which email service is configured for your Neon database authentication and verify the sender details to ensure emails are being sent correctly.

List auth domains

Retrieve all whitelisted domains configured for authentication redirects in your Neon project, allowing you to verify which domains are authorized for user login flows.

List auth oauth providers

Retrieves the list of OAuth providers configured for your Neon project, allowing you to see which third-party authentication methods are available for your application.

List Auth OAuth Providers

Retrieve the OAuth providers that are configured for authentication on a specific Neon database branch, helping you manage and verify which login options are available to your users.

Retrieve jwks for project

Retrieve the public cryptographic keys used by your Neon project to verify authentication tokens, enabling secure token-based access in your applications.

Send auth test email

Verify your email sending configuration is working correctly by sending a test message through your SMTP setup. Use this to confirm emails will deliver properly before relying on your Neon Auth integration for production.

Update auth allow localhost

Controls whether your local development environment can connect to a specific database branch in Neon, enabling or disabling localhost access as needed.

Update auth oauth providers

Update OAuth provider credentials (like Google or GitHub login) for your Neon project's authentication system. This lets you manage which third-party services can authenticate users accessing your application.

Update branch auth email provider

Configure the email provider for your database branch's authentication system, allowing you to customize the sender email and name for authentication-related communications. This uses Neon's managed email infrastructure to ensure reliable delivery of authentication messages.

Get branches backup schedule

Check the automatic backup schedule and retention settings for a specific database branch to ensure your data is protected according to your requirements.

Create new project branch

Create an isolated copy of your database for testing and development without affecting your live data. Each branch is a complete snapshot that you can modify independently, then easily discard or merge back.

Count project branches

Quickly get the total number of database branches in your Neon project, with optional filtering by branch name. This helps you monitor your database infrastructure without retrieving detailed information about each branch.

Create anonymized branch

Creates a new database branch with masked sensitive data using PostgreSQL anonymization, allowing safe development and testing without exposing real customer information.

Delete project branch by id

Permanently removes a database branch from your Neon project, freeing up resources and cleaning up your development environment. Use this when you no longer need a branch after merging changes or completing development work.

Finalize branch restore

Completes a database branch restore from a snapshot by swapping the restored branch into production, ensuring your application immediately uses the recovered data without downtime.

Get branches anonymized status

Check the current status and progress of an anonymized database branch, including whether anonymization is in progress, completed, or encountered errors. Use this to track when your test environments are ready for development work.

Get branches for project

Retrieves all database branches for a specific project in Neon, helping you view and manage different versions of your database environment.

Get project branches

Retrieves detailed information about a specific database branch in your Neon project, including its name, creation date, and current configuration. Use this to verify branch status and gather information before performing updates or migrations.

Modify branch details in project

Update a database branch's name or protection settings in your Neon project without creating a new branch. This lets you organize and secure your development environments more effectively.

Restore project branch

Restores a database branch to a previous state using a specific point in time or transaction marker, allowing you to recover from accidental data changes or test different historical versions of your data.

Set branch as default

Designates a specific branch as the primary branch for your Neon project, making it the default reference point for deployments and integrations. Use this when you want to change which branch represents your main development or production environment.

Start branch anonymization

Initiates the anonymization process to mask sensitive data in a database branch according to predefined rules, ensuring confidential information is protected before sharing or testing with your team.

Get project connection uri

Retrieves the connection URI needed to access a specific Neon project's database, enabling you to connect applications and tools to your project's data resources.

Get consumption history projects

Retrieves detailed consumption metrics for all projects in your Neon organization, including compute time, storage usage, and data written. Use this to understand resource usage patterns and optimize your database infrastructure costs.

Retrieve account consumption history

View your account's resource usage and costs over time to understand how much you're spending on compute, storage, and API calls. This helps you track expenses and identify optimization opportunities.

Create Neon Data API

Set up a REST API interface for your PostgreSQL database, allowing you to query data through HTTP requests without building a custom backend server.

Delete branch data API

Removes Data API access for a specific database within a branch, allowing you to restrict direct database queries when that access is no longer needed.

Get Neon Data API for branch

Retrieves the Data API information for a specific database branch, including the API URL and deployment status. This helps you access the right endpoint and verify your database is ready for your application.

Update branches data API

Modify your database branch's Data API settings including aggregates, authentication, search paths, and CORS configuration to control how external applications access your data.

Create branch database

Creates a new database within a Neon project branch, enabling you to set up isolated database instances for different environments or applications. This is essential for organizing your data infrastructure as your projects grow or when you need separate databases for testing, staging, and production environments.

Delete database from branch

Permanently remove a database from a specific branch in your Neon project to free up resources and maintain a clean infrastructure. This is useful when you no longer need a database and want to eliminate it entirely rather than keeping it inactive.

Fetch database for branch

Retrieves all databases linked to a specific project branch in Neon, helping you manage and track databases across different development environments. Use this to verify which databases exist in each branch without needing to check them individually.

Patch branch database information

Update database properties like name or owner within a Neon project branch without affecting the database data itself. Use this when you need to reorganize your database structure or adjust ownership assignments.

Retrieve branch database details

Fetch detailed information about a specific database in your Neon project, including its configuration, status, and properties. Use this to monitor database health and understand your current setup without making any changes.

Create compute endpoint

Sets up a new database compute instance for your Neon project branch with customizable performance settings, autoscaling, and connection pooling to match your application's needs.

Restart project endpoint

Restarts a Neon database compute endpoint to apply configuration changes, clear cached connections, or resolve performance issues with temporary downtime.

Delete project endpoint

Permanently removes a specific database endpoint from your Neon project and all its associated configurations. Use this when decommissioning endpoints you no longer need to clean up your infrastructure.

Get project endpoint information

Retrieve all database connection endpoints for a specific Neon project, including their hostnames, states, and connection settings. This helps you monitor endpoint health and access the connection details needed to connect applications to your PostgreSQL databases.

Retrieve branch endpoints

Fetches all database connection endpoints for a specific branch, showing their status, configuration, and connection details needed to access your PostgreSQL database.

Retrieve project endpoint details

Retrieve detailed configuration and status information for a specific database endpoint in your Neon PostgreSQL project, including connection hostname, autoscaling settings, and current state.

Start endpoint for project

Activates a suspended or idle database endpoint in your Neon PostgreSQL project, making it ready to accept connections within seconds. This is useful for reducing infrastructure costs while ensuring your database is available when needed.

Suspend project endpoint by id

Temporarily disable a specific endpoint in your Neon project to stop processing requests while preserving its configuration, useful for maintenance or cost control.

Update project compute endpoint settings

Adjust compute endpoint configuration settings like autoscaling, connection pooling, and auto-suspend behavior to optimize performance and control costs for your database workloads.

Get available preload libraries

Retrieves the list of PostgreSQL extensions available for your Neon database project, including their versions and stability status. Use this to discover which extensions you can enable and understand what capabilities are available for your database configuration.

Get branches masking rules

Retrieve the data anonymization configuration rules for a database branch, showing how sensitive information is masked using PostgreSQL Anonymizer. Use this to audit or verify your data protection settings across development and staging environments.

Update branches masking rules

Modify how sensitive data gets automatically anonymized in your database branch, controlling which fields are masked and how they're transformed. This lets you protect customer information while working with realistic test data.

Get project operation by id

Retrieves the status and details of a specific database operation in your Neon project, such as branch creation, compute changes, or configuration updates. Use this to monitor progress, confirm completion, or troubleshoot failed operations.

Retrieve project operations

Retrieves a complete list of operations associated with a specific project, allowing you to monitor ongoing tasks and track completed actions in your database infrastructure. This is essential for auditing changes and understanding the operational history of your project.

Delete organization member

Removes a member from your Neon organization, permanently revoking their access to all database resources and projects. Use this when team members leave, change roles, or no longer need database access.

Fetch organization members by id

Retrieves all members associated with a specific organization, allowing you to view who has access and their details. Use this to manage team membership, verify access levels, and maintain accurate records of your organization.

Get user organizations

Retrieves all organizations that the authenticated user belongs to within the Neon platform. This helps you manage access across multiple projects and teams without manually tracking organizational memberships.

Retrieve organization by id

Fetches detailed information about a specific organization in Neon, including its configuration, members, and projects. Use this to verify organizational settings, check team membership, or audit your account structure.

Retrieve organization invitations

View all pending invitations sent to your organization to see who you've invited and their current status. This helps you manage team onboarding and track whether invited members have accepted their invitations.

Retrieve organization member info

Fetch detailed information about a specific team member in your organization, including their role, join date, and permissions. Use this to verify member status or audit team access levels.

Send organization invitations

Send invitations to users to join your organization and assign them specific roles. This helps you expand your team and manage access control without manually managing each user account.

Update organization member role

Change a team member's role between admin and regular member to control their permissions and access levels within your organization.

Add project email permission

Grant project access to team members or collaborators by adding email-based permissions to a Neon project. This enables you to control who can work on your database infrastructure and what they can do.

Delete project permission

Removes a specific permission from a Neon project, instantly revoking access rights or privileges that are no longer needed. Use this to maintain tight control over who can do what within your database project.

Retrieve project permissions

View who has access to a project and what permissions they have in your Neon workspace. Use this to understand your current team access levels and audit user roles.

Retrieve projects list

Retrieves all Neon database projects linked to your account so you can view and manage your entire project portfolio in one place.

Accept project transfer request

Accepts a pending transfer request to move a Neon database project ownership to your account or organization, completing the handoff process.

Access project details by id

Retrieves comprehensive configuration and metrics for a specific Neon serverless Postgres project, including database settings, compute resources, and consumption data.

Create project transfer request

Initiates a transfer request to move a Neon database project to another account or organization, creating a secure token that the recipient can use to accept ownership within the expiration window.

Create project with quota and settings

Create a new PostgreSQL database project on Neon with custom configuration including resource limits, network settings, and autoscaling options. This lets you set up a production-ready database environment tailored to your specific performance and security needs from day one.

Delete project by id

Permanently removes a Neon PostgreSQL project and all associated data, databases, and configurations. This is an irreversible action useful for cleaning up resources you no longer need.

List shared projects

View all Neon Postgres databases that teammates or collaborators have shared with your account, making it easy to access and manage shared database projects.

Transfer projects between organizations

Moves database projects from one organization to another, enabling you to reorganize your projects as your business structure changes. This is useful during company restructuring, client migrations, or team reorganizations.

Transfer user projects to organization

Move multiple database projects from your personal account to an organization, enabling team-wide access and centralized management. This is useful when scaling your Neon infrastructure or consolidating projects under a company account.

Update project settings by id

Modify your Neon database project's configuration settings including resource limits, security controls, and maintenance schedules to optimize performance and compliance.

Retrieve all regions

Fetches the list of geographic regions where your Neon databases can be deployed, helping you choose the best location for your applications and compliance needs.

Add role to branch

Create a new PostgreSQL database user (role) in a specific branch of your Neon database with automatically generated secure credentials. This enables you to set up different database access levels for applications, team members, or reporting tools.

Delete project branch role

Permanently removes a PostgreSQL role and its associated permissions from a specific database branch in your Neon project. Use this to clean up database access when team members leave or applications are no longer needed.

Get branch roles for project

Retrieve all roles assigned to a specific database branch in your Neon project to understand current access permissions and team member permissions for that branch.

Get project branch role

Retrieve detailed information about a specific role's configuration and permissions within a Neon project branch. Use this to audit access controls, verify current role settings, or prepare for permission changes.

Reset role password for branch

Resets the password for a PostgreSQL role on your Neon branch and generates a new one, allowing you to rotate database credentials securely. This is essential for maintaining database access control and protecting sensitive data.

Reveal role password in branch

Retrieves the password for a database role in a specific branch of your Neon project, allowing you to access or share role credentials when needed. This is useful when you need to reconnect applications or share database access with team members.

Get project branch schema comparison

Compares database schemas between two branches in your Neon project to identify differences, helping you review changes before merging or deploying updates. Shows exactly what structural changes exist between environments in an easy-to-read diff format.

Get schema for project branch

Retrieves the complete PostgreSQL database schema for a specific branch, including all tables, indexes, and other database objects in SQL format. This helps you understand your database structure, document your setup, or compare schemas between different branches.

Create branch snapshot

Captures a snapshot of your database branch at a specific point in time, preserving its exact state for recovery or comparison purposes.

Delete project snapshot

Removes a saved snapshot of your Neon database project to free up storage space and keep your backups organized. Use this when you no longer need an old snapshot and want to clean up unused resources.

List project snapshots

Retrieve all available snapshots for a Neon database project to view backup history and restore points. This helps you track database states and prepare for data recovery when needed.

Restore snapshot to new branch

Restore a database snapshot to a new branch, allowing you to recover from data loss or create a branch from a previous point in time without affecting your production database.

Update project snapshot

Rename a snapshot in your Neon database project to keep your backups organized and easily identifiable. This helps you quickly locate specific database states when you need to restore or reference them.

Get current user information

Retrieves your profile information including username, email, and account details from your Neon account. Use this to access your user-specific settings and personalize your workflow.

Assign or Update VPC Endpoint

Set up or modify a secure private connection between your AWS infrastructure and Neon database using VPC endpoints, eliminating the need to route database traffic over the public internet.

Delete vpc endpoint by ids

Permanently removes a VPC endpoint from your Neon organization, disconnecting the private network link between your AWS VPC and Neon's database service. This action cannot be reversed once completed.

Delete vpc endpoint by project id

Removes a VPC endpoint from your Neon project when it's no longer needed, permanently disconnecting any applications using that endpoint.

Fetch vpcendpoint details by id

Retrieves detailed information about a VPC endpoint connection to your Neon database, including its current status and which projects can access it through private networking.

Get vpc region endpoints

Retrieves all VPC endpoints for your organization in a specific AWS region, showing how your private network connections are configured to AWS services.

List VPC endpoints for organization

Retrieve all VPC endpoints across your Neon organization to view and monitor your network connectivity configurations in one place.

Retrieve vpc endpoints for project

Retrieves all VPC endpoints configured for your project to help you monitor and audit secure private network connections. Use this when you need to verify which endpoints are active and properly configured for your infrastructure.

Set VPC endpoint restriction

Restricts database access to connections from a specific AWS VPC endpoint, ensuring your Neon database can only be reached through secure private network channels. This adds a security layer by blocking all other connection attempts, isolating your data to trusted infrastructure.