Postgres, on a serverless platform designed to help you build reliable and scalable applications faster
Accepts a pending transfer request and irreversibly moves the Neon project to the authenticated account or specified organization. This consumes the request and changes project ownership. Confirm the destination before calling, and do not retry an ambiguous failure because the transfer may already have completed.
Assigns an existing AWS VPC endpoint to a Neon organization, or updates the label of that assignment. Azure regions are unsupported. The endpoint must already exist in AWS and Private Networking requires an eligible Neon plan.
Tool to get the total number of branches in a Neon project. Use when you need to count branches without retrieving full branch details. Optionally filter by branch name using the search parameter.
Creates a Beta anonymized branch using PostgreSQL Anonymizer. It can store masking rules and, when start_anonymization is true, immediately applies irreversible masking to the new branch's copied data.
Creates a new personal API key for the authenticated Neon user account. Use this action to generate API keys for programmatic access to Neon services, such as CI/CD pipelines, backend integrations, or development environments. Each key should have a descriptive name to help identify its purpose. IMPORTANT: The returned 'key' value is shown only once - store it securely immediately after creation. To manage organization-level API keys, use the organization API key endpoints instead.
Creates a new API key for the specified organization in Neon. The API key is used for authenticating and authorizing access to the Neon API. The `key_name` parameter allows for easy identification and management of multiple API keys within the organization. IMPORTANT: The actual API key value is returned only once in the response and cannot be retrieved later. Store it securely immediately after creation. Organization API keys provide admin-level access to all organization resources, including projects, members, and settings. Only organization admins can create these keys.
Tool to generate SDK or API keys for authentication providers. Use when setting up authentication for a Neon project with providers like Stack Auth, Better Auth, or for testing with mock provider.
Creates a Neon Auth user with an email and name for a specified project branch. Neon Auth must already be configured on the branch.
Creates a new database within a specified project and branch in the Neon platform. This endpoint allows users to set up a new database with a custom name and assign an owner role, facilitating the organization and management of databases within the Neon ecosystem. It should be used when initializing a new database for a specific project or when branching requires a separate database instance. The endpoint is particularly useful for developers and database administrators who need to quickly set up new databases as part of their workflow or application deployment process. Note that this operation only creates the database; additional steps may be required to configure specific schemas, tables, or access permissions within the newly created database.
Creates a snapshot from the specified branch at a specific point in time. Snapshots capture the state of a branch and can be used for database versioning, creating backups, or establishing checkpoints for AI agents. Use when you need to preserve the exact state of your database at a moment in time. This endpoint may initiate an asynchronous operation.
Creates a compute endpoint for a Neon branch. Each branch supports at most one read_write endpoint and can have multiple read_only endpoints. Use this to make a branch connectable or add a read replica; it does not modify an existing endpoint.
Creates a Neon Data API REST endpoint for an existing branch database. Authentication is optional: use neon_auth for Neon's managed authentication, or external with jwks_url for an external JWT provider.
Creates a new branch in a Neon project. Branches are copy-on-write clones of the parent branch's data, perfect for creating development/staging environments, testing features, or previewing database changes without affecting production. The branch is created from the project's default branch unless a parent_id is specified. By default, the branch copies all data from the parent ('parent-data'). Note: A branch is created without a compute endpoint. To connect to the branch, use the 'create_compute_endpoint' action to add a read_write or read_only endpoint.
Creates a PostgreSQL role in a Neon branch. Existing connections to the branch's active compute endpoint are dropped; an idle endpoint is activated briefly. The branch must already have a compute endpoint. Login roles receive a generated password in the create response. Set no_login for a group or permission-only role that cannot connect.
Adds a new JSON Web Key Set (JWKS) URL to a Neon project for JWT-based authentication. The JWKS URL must point to a valid HTTPS endpoint that returns cryptographic keys used to verify JSON Web Tokens (JWTs). Use this action to configure authentication with identity providers like Google, Microsoft, Apple, Auth0, Clerk, or Stytch. The JWKS can be scoped to specific branches and mapped to database roles. Maximum of 10 role names can be associated with each JWKS configuration.
Grants the specified email address access to a Neon project. Use this to add a new project collaborator. It creates a project permission; it does not modify an existing permission or select a permission level.
Creates a transfer request for a Neon project. The request expires after its configured validity period. Requires the `urn:neoncloud:orgs:delete` OAuth scope on the connection; it is not in the default scope set.
Creates a Neon project and can also enable logical replication in its project settings. Optional configuration includes quotas, network restrictions, autoscaling, maintenance windows, and default branch settings. WARNING: Enabling logical replication is an irreversible project-settings update and suspends all active compute endpoints; the API does not provide a way to disable it afterward.
Deletes a specific API key from the Neon platform. This endpoint should be used when you need to revoke access for a particular API key, such as when an employee leaves the organization or when you suspect the key has been compromised. The operation is irreversible, so use it with caution. Once deleted, any applications or services using this API key will lose access to Neon's API. This endpoint helps maintain the security of your Neon account by allowing you to manage and control API key access effectively.
Removes trusted redirect domains for an authentication provider from a Neon project's redirect URI allowlist. A not-found response is returned with code 404. DEPRECATED: This is the legacy project-level operation; use the branch-level delete domain operation for new integrations.
Deletes an authentication user from a specified branch within a Neon project. Use this endpoint to permanently remove user access from a particular branch. Important notes: - This operation is permanent and cannot be undone - Successful deletion returns a 204 No Content status - The deleted user will no longer be able to authenticate to the specified branch - This operation only affects the specified branch, not other branches in the project
Deletes domains from the redirect_uri whitelist for a specific branch's authentication configuration. Use when you need to revoke access for specific domains in your Neon authentication setup.
Deletes the Neon Data API for a specified branch and database. Use this when you need to remove Data API access for a specific database within a branch.
Permanently deletes a database and all of its data from the specified project branch. Databases on other branches are unaffected.
Deletes an OAuth provider configuration from a specific branch in a Neon project. This removes the OAuth authentication integration for the specified provider (Google, GitHub, Microsoft, or Vercel) from the given branch. Use this action when you need to revoke OAuth access or clean up authentication configurations for a particular branch. Note: This operation is permanent and will affect all users authenticating through this provider on this branch. Neon Auth must be enabled on the branch before OAuth providers can be deleted.
Deletes a specific API key associated with an organization in the Neon platform. This endpoint is used to revoke access for a particular API key, enhancing security by removing unused or compromised keys. It should be used when an API key is no longer needed, when rotating keys for security purposes, or when an API key may have been exposed. Once deleted, the API key cannot be recovered, and any systems using this key will lose access to the Neon API. Ensure you have a backup or replacement key in place before deletion to avoid service interruptions.
Removes a specific member from a Neon organization. This action permanently revokes the member's access to all organization resources. Use this when an employee leaves the company, changes roles, or their access needs to be revoked. Important notes: - This action cannot be undone; re-adding requires a new invitation - You cannot delete the last admin member of an organization - The member_id must be a valid UUID (not the user's email) - Requires admin permissions on the organization Use fetch_organization_members_by_id first to get valid member IDs.
Deletes a branch and idles its compute endpoints, breaking existing client connections. By default, the branch can be recovered within seven days; set hard_delete to true for immediate permanent deletion. A root or default branch, a branch with children, or a project's only branch cannot be deleted.
Deletes a PostgreSQL role from a specific branch within a Neon project. This permanently removes the role and its associated database permissions. Use this endpoint to: - Remove obsolete user accounts from a database branch - Clean up roles after application decommissioning - Revoke access for former team members Important notes: - This operation is permanent and cannot be undone - The deletion triggers an async 'apply_config' operation on the compute endpoint - If the role doesn't exist, returns 204 No Content (idempotent behavior) - If the role exists and is deleted, returns 200 OK with role and operation details - You cannot delete the default owner role created with the database
Deletes a Neon PostgreSQL project and all its associated resources. Deleted projects can be recovered within seven days using Neon's recover-project endpoint. After that recovery window, the project and its endpoints, branches, databases, users, and configurations are permanently removed. Use this action when: - A project is no longer needed - Cleaning up test/development resources - Removing unused projects to free up quota Returns the details of the deleted project upon successful deletion. Returns 404 if the project does not exist or is not accessible.
Deletes a specific endpoint within a Neon project. This operation permanently removes the endpoint and all associated resources, such as configurations and access points. Use this endpoint when you need to decommission or clean up unused endpoints in your project. It's important to note that this action is irreversible, so ensure you have backed up any necessary data or configurations before proceeding. This endpoint should be used with caution, as it will immediately terminate access to the specified endpoint and may impact any systems or applications relying on it.
Permanently deletes a JWKS configuration from a Neon project. JWT authentication that depends on the removed configuration may stop working.
Revokes project access for the user associated with a permission ID. Obtain the permission ID by listing project access. Returns the revoked permission directly, including its grant and revocation timestamps.
Deletes a specific snapshot for a project in Neon. Use when you need to remove an old or unnecessary snapshot to free up storage or clean up resources. **Note**: This endpoint is currently in Beta.
Permanently deletes a VPC endpoint from a Neon organization in a specified AWS region. This removes the private network connection between your AWS VPC and Neon's service. IMPORTANT: This operation is irreversible. Once a VPC endpoint is deleted from a Neon organization, it cannot be re-added to the same organization. Use with caution. Requirements: - Organization must be on the Scale plan (VPC/Private Networking is not available on Free plan) - Only AWS regions are supported (not Azure) - The VPC endpoint must exist in the specified organization and region This action is useful when decommissioning private network connections or cleaning up unused VPC endpoints. Deleting a VPC endpoint will disrupt any applications relying on private connectivity through that endpoint.
Removes a VPC endpoint restriction from a Neon project. It does not delete or unassign the VPC endpoint from its organization. Connections through that VPC endpoint are no longer permitted by this project-level restriction.
Disables Neon Auth for a specified project branch, removing its connection to the authentication provider. The optional delete_data setting requests deletion of the branch database's neon_auth schema and associated authentication data.
Tool to enable Neon Auth integration for a branch. Use when you need to set up authentication for a specific branch in a Neon project.
Finalizes the restore operation for a branch created from a snapshot. This updates the branch to function as the original branch it replaced by: reassigning computes from the original branch (which restarts them), renaming the restored branch to the original's name, and renaming the original branch. Only applies to branches created using the restoreSnapshot endpoint.
Retrieves selected consumption metrics for projects in a Neon organization, grouped by project, billing period, and the requested granularity. Omit project_ids to include all projects, and pass a returned cursor unchanged to retrieve the next page. This request does not wake project computes.
Retrieves authentication information about the current API request credentials. Use this action to verify which account and authentication method are being used for API calls, which is helpful for debugging authentication issues or confirming the identity of the calling user or API key.
Retrieves the allow localhost configuration for a specific branch in a Neon project. Use when you need to check if localhost connections are permitted for a branch's authentication settings.
Retrieves the email provider configuration for Neon Auth on a specific branch. Returns SMTP configuration details if a custom provider is configured, or just sender information if using the default Neon email provider. Use this action to verify email settings before testing authentication flows or troubleshooting email delivery issues.
Returns metadata and configuration for one database in a project branch without modifying the database.
Retrieves the current status of an anonymized branch, including its state and progress information. This endpoint allows you to monitor the anonymization process from initialization through completion. Only anonymized branches will have status information available. Use this action when you need to: - Monitor the progress of an anonymization process - Check the state of an anonymized branch (created, initialized, anonymizing, anonymized, error) - View details about the most recent anonymization attempt - Identify when an anonymization operation failed Note: This endpoint is currently in Beta.
Retrieves the backup schedule configuration for a specified branch within a Neon project. This endpoint provides information about when backups are created and how long they are retained. Use this when you need to verify or audit the backup schedule settings for a branch. Note: This endpoint is currently in Beta.
Retrieves the masking rules for the specified anonymized branch. Masking rules define how sensitive data should be anonymized using PostgreSQL Anonymizer. Use this when you need to view the data anonymization configuration for a branch. Note: This endpoint is currently in Beta.
Gets account identifiers, plan details, and linked auth accounts for the currently authenticated Neon user. This action requires credentials tied to a user; organization- and project-scoped API keys do not represent a current user. It accepts no parameters and cannot retrieve another user's profile.
Retrieves the Neon Data API information for a specific branch and database. Use when you need to access the Data API URL, deployment status, or configuration settings for a particular database within a branch.
Retrieves one Neon organization's identity and account settings, including its name, handle, billing plan, management source, timestamps, and available organization-level flags. It does not list the organization's members or projects; use the corresponding list actions for those resources.
Returns one organization's member record, including the associated user ID, organization role, and join timestamp.
Retrieves detailed information about a specific Neon serverless Postgres project. Returns project data including configuration, database settings, compute resources, owner information, and consumption metrics. Use this action when you need to: - Get project configuration details (region, PostgreSQL version, settings) - Check project ownership and organization membership - Review compute and storage consumption metrics - Verify project settings before making updates The action is read-only and safe to call frequently. For listing multiple projects, use the retrieve_projects_list action instead.
Retrieves detailed information about a specific branch within a Neon project. This endpoint allows developers to fetch the current state and configuration of a branch, including its name, creation timestamp, and other relevant metadata. It's particularly useful when you need to verify branch details, check its status, or gather information for further operations on the branch. The endpoint should be used when you require up-to-date information about a single branch in your project's context. Note that this endpoint only provides read access and does not modify any branch data.
Returns a specific PostgreSQL role's branch ID, name, protected status, authentication method, creation and update timestamps, and any related Neon operations. It does not return the role's PostgreSQL privileges, grants, or memberships, and it does not return Neon project permission grants.
Compares the database schema of a branch with another branch's schema in a Neon project. Returns the difference as a unified diff format string. Use this when you need to understand what schema changes exist between two branches (e.g., before merging, to review migrations, or to verify schema consistency). The comparison can be done at specific points in time using LSN or timestamp parameters for both branches.
Returns a PostgreSQL connection URI for a database and role in a Neon project. Optionally targets a branch or endpoint and can return a pooled URI.
Retrieves detailed information about a specific compute endpoint within a Neon serverless PostgreSQL project. Compute endpoints are the connection points for your Neon databases. Use this action to get information about a specific endpoint including its hostname for connections, autoscaling settings, current state (active/idle/suspended), connection pooling config, and PostgreSQL settings. This is useful for getting the connection hostname, checking endpoint health, verifying compute resources, or troubleshooting connection issues. The endpoint_id can be obtained from the list endpoints action. Note: This is a read-only operation.
Retrieves detailed information about a specific operation within a Neon serverless PostgreSQL project. Use this endpoint to check the status and details of operations such as compute start/suspend, branch creation/deletion, configuration changes, or timeline operations. This is useful for monitoring long-running tasks, verifying operation completion, or debugging failures. Requires both a project ID and operation ID. Returns operation details including status ('scheduling', 'running', 'finished', 'failed'), duration, and associated branch/endpoint IDs. This is a read-only endpoint.
Retrieves the PostgreSQL database schema (DDL) for a specific database on a branch within a Neon project. Returns the schema as SQL statements (similar to pg_dump output), including CREATE TABLE, ALTER TABLE, CREATE INDEX, and other DDL statements. This is useful for understanding the database structure, comparing schemas between branches, or for documentation purposes. The schema can be retrieved at the current point in time or at a specific historical point using either an LSN or timestamp parameter. Note: The branch's compute endpoint must be active for this endpoint to work.
Retrieves the current state and configuration details of a specific VPC endpoint assigned to a Neon organization. VPC endpoints enable private connectivity between your AWS VPC and Neon databases using AWS PrivateLink, bypassing the public internet. Prerequisites: - Organization must be on the Scale plan or higher (VPC Private Networking is not available on Free or Launch plans) - VPC endpoint must be previously assigned using 'create_vpc_endpoint_with_label' action Use cases: - Check the operational state of a VPC endpoint (new, accepted, available, pending, rejected) - View which projects are restricted to use this VPC endpoint - Verify endpoint configuration for compliance and security auditing - Troubleshoot private connectivity issues Note: This is a read-only endpoint. To modify VPC endpoint configuration, use 'create_vpc_endpoint_with_label' or 'delete_vpc_endpoint_by_ids' actions.
Lists API keys for the authenticated user's Neon account, including key IDs, names, creators, creation times, and last-use metadata. It does not return secret key values or create, update, or delete keys.
Lists trusted redirect domains for the specified project and branch. An upstream 404 is returned as an empty domain list.
Deprecated project-level endpoint for listing OAuth providers. Use the branch-level list action for new integrations. This legacy action intentionally keeps its project-only request contract so existing calls remain valid.
Retrieves the list of available shared preload libraries for a Neon project. Shared preload libraries are PostgreSQL extensions that can be loaded at server startup using the shared_preload_libraries setting. Use this action when you need to: - Discover which PostgreSQL extensions are available for your project - Check versions of available extensions (TimescaleDB, pg_cron, etc.) - Identify experimental vs. stable extensions before configuration - Review default libraries included in your project configuration Returns details about each library including name, version, description, and whether it's experimental or included by default. Common extensions include timescaledb (time-series data), pg_cron (job scheduling), pg_partman_bgw (partition management), and vector search extensions.
Lists OAuth providers configured for a specific branch's Neon Auth integration. This is the current branch-level endpoint. The response can contain OAuth client IDs and sensitive client secrets; do not expose or log returned credentials.
Retrieves a list of databases associated with a specific project and branch in the Neon platform. This endpoint allows developers to view all databases within a particular project and branch context, which is useful for managing different environments (e.g., development, staging, production) or versions of an application's database setup. It should be used when you need to inventory the databases in a specific branch or verify the existence of databases in a particular project environment. The endpoint does not provide detailed information about each database's schema or contents; it's primarily for listing purposes.
Retrieves all compute endpoints associated with a specific branch in a Neon project. Compute endpoints are the connection points for accessing your PostgreSQL database - they provide the hostname and configuration needed to connect to your database. Use this action when you need to: - Get connection details (host, region) for a branch's database - Check endpoint status (active, idle, suspended) - Review autoscaling and connection pooling settings - Monitor endpoint activity and configuration Returns a list of endpoints with details like host, region, current state, autoscaling limits, and pooler configuration. Most branches have one read_write endpoint, but may have additional read-only replicas.
Lists API keys for a Neon organization, including key IDs, names, creators, creation times, and last-use metadata. This read-only action does not return secret key values or change access permissions.
Lists pending invitations for a Neon organization. Returns each invitation's ID, invitee email, assigned role, inviter ID, and invitation timestamp. This action is read-only: it does not manage invitations, return per-invitation status fields, or list active organization members.
Retrieves one paginated page of organization members. Use pagination.next as cursor with the same sort options to fetch the next page. Use this read-only action to review membership, roles, and member email addresses.
Lists Postgres roles on a specific Neon project branch. Returns role names, protection status, and creation and update times; it does not return roles from other branches or change role permissions.
Lists branches in a Neon project, optionally filtering by a partial branch name or ID. Returns branch identity, hierarchy, state, storage, expiration, and creation metadata. This collection read does not retrieve one specific branch.
Lists paginated legacy project consumption history for an organization or the authenticated user's projects on eligible Scale, Business, and Enterprise plans, without waking sleeping computes. Metrics include compute activity and written data; synthetic storage size is deprecated and always zero.
Lists compute endpoints for a Neon project, including each endpoint's ID, branch, hostname, state, region, autoscaling limits, and pooling settings. This action returns hostnames and endpoint metadata, not complete database connection strings or credentials.
Lists the JWKS URL configurations Neon uses to verify JWTs for a project. Returns configuration IDs, provider names, JWKS endpoint URLs, audiences, permitted database roles, and optional branch restrictions. It does not fetch or return the public keys from those URLs.
Lists one cursor-paginated page of asynchronous operations for a Neon project, including each operation's action, current status, timestamps, failure count, and associated branch or endpoint when applicable. Operations older than six months may no longer be available. Pass the returned cursor unchanged to fetch the next page.
Lists email-based grants that give users access to a Neon project. Returns each permission ID, recipient email, grant time, and revocation time when applicable. It does not return organization roles, database privileges, or historical permission changes.
Lists snapshots for a Neon project, including their source branch, creation and expiration times, LSN, and whether they were created manually. This endpoint is currently in beta.
Lists the VPC endpoints associated with a Neon project. This read-only action returns existing private-network configurations and does not modify them.
Lists one cursor-paginated page of projects for the specified organization, with summary project fields and installed application/integration maps. Use the returned pagination cursor to request another page. A timeout can return a partial page; unavailable_project_ids identifies projects not fetched in time. With a personal API key, provide org_id to choose an organization. Organization API keys infer org_id from the key.
Lists active geographic regions available for Neon projects, including region identifiers, names, default status, and geographic coordinates.
Lists Neon Postgres projects shared with the authenticated account. Supports filtering by project name or ID and cursor pagination with 1 to 400 projects per page. This read-only action does not manage shared projects.
Lists organizations the currently authenticated user belongs to. With an organization- or project-scoped API key, lists only the organization that owns the key. The response does not include pending invitations.
Lists VPC endpoints for a Neon organization across all regions, including each endpoint's ID, label, and region.
Lists VPC endpoints for a Neon organization in one region, including each endpoint's ID and label. This read-only action does not return full endpoint state or restricted-project details and does not modify endpoints.
Resets the password for a PostgreSQL role on a specific Neon branch and generates a new password. Use this when credentials need to be rotated for security purposes (e.g., employee offboarding, suspected compromise, or routine security practices). The response includes the new password - store it securely as it cannot be retrieved later. The new password becomes active once the triggered 'apply_config' operation completes; the old password remains valid until then. Note: This is a destructive operation that invalidates the current password.
Restarts a Neon compute endpoint (Postgres instance) within a project. The restart operation suspends and then starts the compute endpoint, which is useful for: - Applying configuration changes - Clearing cached data or connections - Troubleshooting connection or performance issues - Recovering from error states The operation triggers two sequential actions: 'suspend_compute' followed by 'start_compute'. During restart, the endpoint will be briefly unavailable. The response includes the updated endpoint details and the operations triggered. Note: If the endpoint is in a 'locked' state (HTTP 423) due to an ongoing operation, wait for it to complete before retrying. If the endpoint is 'idle', it will be started directly without suspension.
Restores a branch from another point in its own or another branch's history, replacing the target branch's current data and creating a branch for the restored state. This is destructive: never run it autonomously; always ask the user for confirmation first. Use preserve_under_name to retain the target's current state; it is required for self-restores and targets with child branches, whose children are moved to the preserved branch.
Restores a snapshot by creating a new preview branch. By default, the original branch and its computes are unchanged so the restored data can be inspected. When finalize_restore is true, the restore is finalized immediately: the new branch replaces the target branch and associated computes move to it. This replacement is destructive and should be confirmed with the user. This endpoint is currently in Beta.
Reveals the password for a specific role within a branch of a Neon project. This endpoint is used when you need to retrieve a previously hidden or encrypted password for a database role. It's particularly useful for administrators who need to access or share role credentials securely. The endpoint should be used cautiously, as it exposes sensitive information. It does not modify the password, only retrieves it. Note that frequent use of this endpoint may be logged or restricted for security purposes.
Sends one test email to the specified recipient using the supplied SMTP configuration. Sending is an irreversible external side effect: verify the recipient and SMTP settings before calling. Do not retry after a timeout or other ambiguous failure because the first email may already have been sent.
Invites one or more people to a Neon organization with assigned roles. Existing Neon users join automatically; people without accounts receive email invitations. These membership and email side effects cannot be recalled. Verify every address and role before calling, and do not retry an ambiguous failure because invitations may already have been processed.
Sets a specified branch as the default branch for a given project in Neon. This endpoint allows users to designate a particular branch as the primary or main branch for a project, which can be useful for organizing workflows and setting default behaviors. The operation is performed using a POST request, indicating that it modifies the state of the project. Use this endpoint when you need to change the default branch of a project, such as after creating a new branch or deciding to switch the main development focus. It's important to note that this action may affect how other operations interact with the project, as many systems use the default branch as a reference point for various functionalities.
Sets or updates a VPC endpoint restriction for a Neon project. When a VPC endpoint restriction is set, the project only accepts connections from the specified VPC endpoint, providing network-level security isolation. This is useful for Private Networking scenarios where you want to restrict database access to only connections coming through a specific AWS VPC endpoint. The VPC endpoint must first be assigned to the parent organization (using the organization-level VPC endpoint API) before it can be used as a project restriction. The operation is idempotent - repeated calls with the same parameters will not create additional changes. Note: This is a paid feature requiring a Neon Business or Enterprise plan.
Starts the Beta anonymization process on an anonymized branch in the `initialized`, `error`, or `anonymized` state. This applies the branch's masking rules and irreversibly changes its database values. Verify the branch and rules before calling. Do not retry an ambiguous failure because the first anonymization run may already have started.
Starts a suspended or idle compute endpoint for a Neon PostgreSQL project. Neon compute endpoints automatically suspend after a period of inactivity to save resources. Use this action to wake up a suspended endpoint and make it available for database connections. The endpoint will transition from 'idle' or 'suspended' state to 'active'. If the endpoint is already active, the call is idempotent and returns the current endpoint state with no operations. The response includes the endpoint details and any triggered operations. Note: Endpoint startup typically takes a few seconds.
Suspends a specified Neon project's compute endpoint, helping manage compute resource usage and costs. The response includes endpoint details and any initiated operations.
Transfers selected projects from one organization to another organization. Use this when you need to move projects between organizations, for example during organizational restructuring or mergers. Note that projects with GitHub or Vercel integrations cannot be transferred and will cause the request to fail. WARNING: The ownership transfer has no inverse endpoint. Verify the source organization, destination organization, and every project ID before calling, and do not retry an ambiguous failure because the transfer may already have completed. Requires the `urn:neoncloud:orgs:delete` OAuth scope on the connection; it is not in the default scope set.
Deprecated by Neon: personal accounts have been migrated to organizations, and Neon scheduled this endpoint for removal on July 1, 2026. For a still eligible account, this moves 1-400 projects from personal ownership to the destination organization; it does not delete project data. The ownership transfer has no inverse endpoint. Verify all project and organization IDs, and do not retry an ambiguous failure because the transfer may have completed.
Updates the localhost allow setting for Neon Auth on a specific branch, enabling or disabling localhost origins for authentication flows.
Updates OAuth provider credentials for a Neon project's authentication configuration. DEPRECATED: Use `/projects/{project_id}/branches/{branch_id}/auth/oauth_providers/{oauth_provider_id}` instead. This endpoint allows updating client ID and client secret for OAuth providers (Google, GitHub, Microsoft, or Vercel).
Updates the email provider settings for a Neon Auth branch, including the sender address and name used for authentication emails. Omit SMTP fields to use the shared provider; if supplying SMTP settings, provide the host, port, username, and password together.
Updates the properties of a specific database within a project branch in the Neon platform. This endpoint allows for partial modifications of database attributes, such as changing its name or owner. It should be used when you need to rename a database or transfer ownership to a different role within the same project and branch. The update is performed using the PATCH method, allowing for selective property changes without affecting unspecified attributes. Note that this operation modifies existing database metadata and does not create new databases or alter the actual data within the database.
Updates the Neon Data API configuration for the specified branch. Omit all optional settings to refresh only the schema cache. Only settings supplied by the caller are updated.
Updates the masking rules for the specified anonymized branch. Masking rules define how sensitive data should be anonymized using PostgreSQL Anonymizer. Use this when you need to add, modify, or remove data anonymization rules for a branch. Note: This endpoint is currently in Beta.
Changes an organization member's role between `admin` and `member`, updating their ability to manage organization resources and members.
Updates the details of a specific branch within a project in the Neon platform. This endpoint allows you to modify the name and protection status of an existing branch. It is particularly useful when you need to rename a branch or change its protection settings without creating a new branch. The endpoint uses partial updates, so you can specify only the fields you want to change. This tool should be used when managing branch configurations in a Neon project, but it cannot be used to create new branches or delete existing ones.
Updates the configuration of a specific compute endpoint within a Neon project. This endpoint allows fine-tuning of various settings such as autoscaling limits, provisioner type, connection pooling, and auto-suspend behavior. It's particularly useful for optimizing performance, resource allocation, and cost management of your Neon compute endpoints. The endpoint should be used when you need to modify the behavior or resources of an existing compute endpoint to better suit your application's needs or to implement changes in your infrastructure strategy. Note that some parameters are deprecated, and care should be taken to use the most current features and settings.
Updates selected project settings, including quotas, network access, maintenance, history retention, and default compute settings. This is not always destructive, but enabling logical replication is irreversible and suspends all active endpoints. Blocking public or VPC connections can also interrupt clients. Verify the target project and consequential values before calling, and do not retry an ambiguous failure because changes may have applied.
Tool to update the name of a specific snapshot in a Neon project. Use when you need to rename a snapshot to better reflect its purpose or content. This endpoint is currently in Beta.
The Neon integration connects your Dench AI CRM directly to Neon, so agents can read and act on your Neon data as part of everyday work — answering questions in chat, keeping your CRM in sync, and running automations without anyone copying data between tools.
110 actions are available for agents to invoke on your behalf. Every call runs through Neon's own authorization, scoped to the account you connect.
Sign in to your Dench workspace and open Integrations.
Find Neon and click Connect — you'll authorize access through Neon's own sign-in flow. No API keys or code required.
Ask an agent to use Neon in chat, or call it from an automation.
Manage or disconnect the connection any time from workspace settings.
The Dench Neon integration connects your AI CRM to Neon, so AI agents can work with your Neon data as part of chats, automations, and CRM workflows. You connect your account once, and every agent in your workspace can use it — governed by your workspace permissions.
The Neon integration currently exposes 110 actions, including Accept project transfer request, Assign or Update VPC Endpoint, Count project branches, Create anonymized branch, Create API key, and Create API Key for Organization. Agents invoke them on your behalf from chat or from automations.
No. You connect Neon from your Dench workspace using Neon's own sign-in and authorization flow — no API keys to copy, no glue code to maintain.
Connections are authorized through Neon's own authentication flow, and Dench stores only the authorization needed to act on your behalf. You can review and disconnect the Neon connection from your workspace settings at any time.