- Category: databases
- Auth: API_KEY, OAUTH2
- Composio-managed OAuth available? No
- Tools: 110
- Triggers: 0
- Slug:
NEON - Version: 20261101_00
Tools
Accept project transfer request
Accept project transfer request
NEON_ACCEPT_PROJECTS_TRANSFER_REQUESTSAccepts 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.Input Parameters
Output
Count project branches
Count project branches
Create API key
Create API key
NEON_CREATE_API_KEYCreates 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.Input Parameters
Output
Create API Key for Organization
Create API Key for Organization
NEON_CREATE_API_KEY_FOR_ORGANIZATIONCreates 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.Input Parameters
Output
Create Auth Provider SDK Keys
Create Auth Provider SDK Keys
NEON_CREATE_AUTH_KEYSTool 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.Input Parameters
Output
Create auth user
Create auth user
NEON_CREATE_AUTH_USERCreates a Neon Auth user with an email and name for a specified project branch. Neon Auth must already be configured on the branch.Input Parameters
Output
Create branch database
Create branch database
NEON_CREATE_BRANCH_DATABASECreates 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.Input Parameters
Output
Enable Neon Auth for branch
Enable Neon Auth for branch
NEON_CREATE_BRANCHES_AUTHTool to enable Neon Auth integration for a branch. Use when you need to set up authentication for a specific branch in a Neon project.Input Parameters
Output
Create Neon Data API
Create Neon Data API
NEON_CREATE_BRANCHES_DATA_APICreates 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.Input Parameters
Output
Create branch snapshot
Create branch snapshot
NEON_CREATE_BRANCHES_SNAPSHOTCreates 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.Input Parameters
Output
Create compute endpoint
Create compute endpoint
NEON_CREATE_COMPUTE_ENDPOINTCreates 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.Input Parameters
region_id is permitted.k8s-neonvm provisioner to create a compute endpoint that supports autoscaling. Documented values are k8s-pod, k8s-neonvm, docker, and serverless-platform.read_write or read_only.0 means use the global default. The value -1 means never suspend. The default value is 300 seconds (5 minutes). The minimum value is 60 seconds (1 minute). The maximum value is 604800 seconds (1 week). For more information, see Auto-suspend configuration.Output
Create project branch
Create project branch
NEON_CREATE_PROJECT_BRANCHCreates 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.Input Parameters
Output
Create anonymized branch
Create anonymized branch
NEON_CREATE_PROJECT_BRANCH_ANONYMIZEDCreates 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.Input Parameters
Output
Create project branch role
Create project branch role
NEON_CREATE_PROJECT_BRANCH_ROLECreates 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.Input Parameters
Output
Create project JWKS
Create project JWKS
NEON_CREATE_PROJECT_JWKSAdds 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.Input Parameters
Output
Create project permission
Create project permission
NEON_CREATE_PROJECT_PERMISSIONGrants 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.Input Parameters
Output
Create project transfer request
Create project transfer request
NEON_CREATE_PROJECTS_TRANSFER_REQUESTSCreates 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.Input Parameters
Output
Create project with quota and settings
Create project with quota and settings
NEON_CREATE_PROJECT_WITH_QUOTA_AND_SETTINGSCreates 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.Input Parameters
aws-us-east-1k8s-neonvm provisioner to create a compute endpoint that supports Autoscaling. Supported values are k8s-pod, k8s-neonvm, docker, and serverless-platform.0 means use the global default. The value -1 means never suspend. The default value is 300 seconds (5 minutes). The minimum value is 60 seconds (1 minute). The maximum value is 604800 seconds (1 week). For more information, see Auto-suspend configuration.Output
Set VPC endpoint restriction
Set VPC endpoint restriction
NEON_CREATE_VPC_ENDPOINT_LABELSets 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.Input Parameters
Output
Assign or Update VPC Endpoint
Assign or Update VPC Endpoint
NEON_CREATE_VPC_ENDPOINT_WITH_LABELAssigns 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.Input Parameters
Output
Delete api key by id
Delete api key by id
NEON_DELETE_API_KEY_BY_IDDeletes 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.Input Parameters
Output
Delete auth domain from project
Delete auth domain from project
NEON_DELETE_AUTH_DOMAIN_FROM_PROJECTRemoves 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.Input Parameters
Output
Delete OAuth provider
Delete OAuth provider
NEON_DELETE_AUTH_OAUTH_PROVIDERDeletes 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.Input Parameters
Output
Delete auth user
Delete auth user
NEON_DELETE_AUTH_USERDeletes 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 projectInput Parameters
Output
Delete branch auth domains
Delete branch auth domains
NEON_DELETE_BRANCH_AUTH_DOMAINSDeletes 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.Input Parameters
Output
Delete branch data API
Delete branch data API
NEON_DELETE_BRANCH_DATA_APIDeletes 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.Input Parameters
Output
Delete database from branch
Delete database from branch
NEON_DELETE_DATABASE_FROM_BRANCHPermanently deletes a database and all of its data from the specified project branch. Databases on other branches are unaffected.Input Parameters
Output
Delete organization api key
Delete organization api key
NEON_DELETE_ORGANIZATION_API_KEYDeletes 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.Input Parameters
Output
Delete organization member
Delete organization member
NEON_DELETE_ORGANIZATION_MEMBERRemoves 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.Input Parameters
Output
Delete project branch by id
Delete project branch by id
NEON_DELETE_PROJECT_BRANCH_BY_IDDeletes 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.Input Parameters
Output
Delete project branch role
Delete project branch role
NEON_DELETE_PROJECT_BRANCH_ROLEDeletes 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 databaseInput Parameters
Output
Delete project by id
Delete project by id
NEON_DELETE_PROJECT_BY_IDDeletes 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.Input Parameters
Output
Delete project endpoint
Delete project endpoint
NEON_DELETE_PROJECT_ENDPOINTDeletes 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.Input Parameters
Output
Delete project jwks by id
Delete project jwks by id
Delete project permission
Delete project permission
NEON_DELETE_PROJECT_PERMISSIONRevokes 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.Input Parameters
Output
Delete project snapshot
Delete project snapshot
NEON_DELETE_PROJECT_SNAPSHOTDeletes 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.Input Parameters
Output
Delete vpc endpoint by ids
Delete vpc endpoint by ids
NEON_DELETE_VPC_ENDPOINT_BY_IDSPermanently 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.Input Parameters
Output
Delete vpc endpoint by project id
Delete vpc endpoint by project id
Disable branches auth
Disable branches auth
Finalize branch restore
Finalize branch restore
NEON_FINALIZE_BRANCH_RESTOREFinalizes 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.Input Parameters
Output
Get account consumption history
Get account consumption history
NEON_GET_ACCOUNT_CONSUMPTION_HISTORYRetrieves 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.Input Parameters
Output
Get auth
Get auth
NEON_GET_AUTHRetrieves 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.Output
Get auth allow localhost
Get auth allow localhost
Get auth email provider
Get auth email provider
NEON_GET_AUTH_EMAIL_PROVIDERRetrieves 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.Input Parameters
Output
Get branch database
Get branch database
Get branches anonymized status
Get branches anonymized status
NEON_GET_BRANCHES_ANONYMIZED_STATUSRetrieves 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.Input Parameters
Output
Get branches backup schedule
Get branches backup schedule
NEON_GET_BRANCHES_BACKUP_SCHEDULERetrieves 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.Input Parameters
Output
Get Neon Data API for branch
Get Neon Data API for branch
Get branches masking rules
Get branches masking rules
NEON_GET_BRANCHES_MASKING_RULESRetrieves 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.Input Parameters
Output
Get current user information
Get current user information
NEON_GET_CURRENT_USER_INFORMATIONGets 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.Output
Get organization
Get organization
NEON_GET_ORGANIZATIONRetrieves 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.Input Parameters
Output
Get organization member
Get organization member
NEON_GET_ORGANIZATION_MEMBERReturns one organization’s member record, including the associated user ID, organization role, and join timestamp.Input Parameters
Output
Get project
Get project
NEON_GET_PROJECTRetrieves 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.Input Parameters
Output
Get project branch
Get project branch
NEON_GET_PROJECT_BRANCHRetrieves 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.Input Parameters
Output
Get project branch role
Get project branch role
NEON_GET_PROJECT_BRANCH_ROLEReturns 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.Input Parameters
Output
Get project branch schema comparison
Get project branch schema comparison
NEON_GET_PROJECT_BRANCH_SCHEMA_COMPARISONCompares 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.Input Parameters
Output
Get project connection uri
Get project connection uri
NEON_GET_PROJECT_CONNECTION_URIReturns 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.Input Parameters
-pooler option to the connection URI when set to true, creating a pooled connection URI.Output
Get project endpoint
Get project endpoint
NEON_GET_PROJECT_ENDPOINTRetrieves 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.Input Parameters
Output
Get project operation by id
Get project operation by id
NEON_GET_PROJECT_OPERATION_BY_IDRetrieves 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.Input Parameters
Output
Get schema for project branch
Get schema for project branch
NEON_GET_SCHEMA_FOR_PROJECT_BRANCHRetrieves 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.Input Parameters
Output
Get VPC endpoint details
Get VPC endpoint details
NEON_GET_VPC_ENDPOINT_DETAILSRetrieves 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.Input Parameters
Output
List api keys
List api keys
List auth domains
List auth domains
List auth oauth providers
List auth oauth providers
List available preload libraries
List available preload libraries
NEON_LIST_AVAILABLE_PRELOAD_LIBRARIESRetrieves 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.Input Parameters
Output
List branch auth OAuth providers
List branch auth OAuth providers
NEON_LIST_BRANCH_AUTH_OAUTH_PROVIDERSLists 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.Input Parameters
Output
List branch databases
List branch databases
NEON_LIST_BRANCH_DATABASESRetrieves 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.Input Parameters
Output
List branch endpoints
List branch endpoints
NEON_LIST_BRANCH_ENDPOINTSRetrieves 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.Input Parameters
Output
List organization API keys
List organization API keys
List organization invitations
List organization invitations
NEON_LIST_ORGANIZATION_INVITATIONSLists 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.Input Parameters
Output
List organization members
List organization members
NEON_LIST_ORGANIZATION_MEMBERSRetrieves 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.Input Parameters
Output
List project branches
List project branches
List project branch roles
List project branch roles
List project consumption history
List project consumption history
NEON_LIST_PROJECT_CONSUMPTION_HISTORYLists 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.Input Parameters
date-time for the consumption period. The date-time value is rounded according to the specified granularity. For example, 2024-03-15T15:30:00Z for daily granularity will be rounded to 2024-03-15T00:00:00Z. The specified date-time value must respect the specified granularity: - For hourly, consumption metrics are limited to the last 168 hours. - For daily, consumption metrics are limited to the last 60 days. - For monthly, consumption metrics are limited to the last year.date-time for the consumption period. The date-time value is rounded according to the specified granularity. For example, 2024-03-15T15:30:00Z for daily granularity will be rounded to 2024-03-15T00:00:00Z. The specified date-time value must respect the specified granularity: - For hourly, consumption metrics are limited to the last 168 hours. - For daily, consumption metrics are limited to the last 60 days. - For monthly, consumption metrics are limited to the last year. The consumption history is available starting from March 1, 2024, at 00:00:00 UTC.project_ids=cold-poetry-09157238%20&project_ids=quiet-snow-71788278 - As a comma-separated list in a single parameter value: project_ids=cold-poetry-09157238,quiet-snow-71788278Output
List project endpoints
List project endpoints
NEON_LIST_PROJECT_ENDPOINTSLists 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.Input Parameters
Output
List project JWKS configurations
List project JWKS configurations
NEON_LIST_PROJECT_JWKSLists 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.Input Parameters
Output
List project operations
List project operations
NEON_LIST_PROJECT_OPERATIONSLists 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.Input Parameters
Output
List project permissions
List project permissions
NEON_LIST_PROJECT_PERMISSIONSLists 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.Input Parameters
Output
List projects
List projects
NEON_LIST_PROJECTSLists 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.Input Parameters
Output
List project snapshots
List project snapshots
NEON_LIST_PROJECTS_SNAPSHOTSLists 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.Input Parameters
Output
List project VPC endpoints
List project VPC endpoints
List regions
List regions
List user organizations
List user organizations
List VPC endpoints for organization
List VPC endpoints for organization
List VPC region endpoints
List VPC region endpoints
Reset role password for branch
Reset role password for branch
NEON_RESET_ROLE_PASSWORD_FOR_BRANCHResets 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.Input Parameters
Output
Restart project endpoint
Restart project endpoint
NEON_RESTART_PROJECT_ENDPOINTRestarts 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.Input Parameters
Output
Restore project branch
Restore project branch
NEON_RESTORE_PROJECT_BRANCHRestores 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.Input Parameters
Output
Restore snapshot to new branch
Restore snapshot to new branch
NEON_RESTORE_SNAPSHOTRestores 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.Input Parameters
Output
Reveal role password in branch
Reveal role password in branch
NEON_REVEAL_ROLE_PASSWORD_IN_BRANCHReveals 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.Input Parameters
Output
Send auth test email
Send auth test email
NEON_SEND_AUTH_TEST_EMAILSends 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.Input Parameters
Output
Send organization invitations
Send organization invitations
NEON_SEND_ORGANIZATION_INVITATIONSInvites 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.Input Parameters
email and assigned organization role.Output
Set branch as default
Set branch as default
NEON_SET_BRANCH_AS_DEFAULTSets 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.Input Parameters
Output
Start branch anonymization
Start branch anonymization
NEON_START_BRANCH_ANONYMIZATIONStarts 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.Input Parameters
Output
Start endpoint for project
Start endpoint for project
NEON_START_ENDPOINT_FOR_PROJECTStarts 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.Input Parameters
Output
Suspend project endpoint by id
Suspend project endpoint by id
Transfer projects between organizations
Transfer projects between organizations
NEON_TRANSFER_PROJECTS_BETWEEN_ORGANIZATIONSTransfers 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.Input Parameters
Output
Transfer user projects to organization
Transfer user projects to organization
NEON_TRANSFER_USER_PROJECTS_TO_ORGANIZATIONDeprecated 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.Input Parameters
Output
Update auth allow localhost
Update auth allow localhost
NEON_UPDATE_AUTH_ALLOW_LOCALHOSTUpdates the localhost allow setting for Neon Auth on a specific branch, enabling or disabling localhost origins for authentication flows.Input Parameters
Output
Update branch auth email provider
Update branch auth email provider
NEON_UPDATE_AUTH_EMAIL_PROVIDERUpdates 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.Input Parameters
Output
Update auth oauth providers
Update auth oauth providers
NEON_UPDATE_AUTH_OAUTH_PROVIDERSUpdates 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).Input Parameters
Output
Update branch database
Update branch database
NEON_UPDATE_BRANCH_DATABASEUpdates 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.Input Parameters
Output
Update branches data API
Update branches data API
NEON_UPDATE_BRANCHES_DATA_APIUpdates 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.Input Parameters
Output
Update branches masking rules
Update branches masking rules
NEON_UPDATE_BRANCHES_MASKING_RULESUpdates 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.Input Parameters
Output
Update organization member role
Update organization member role
Update project branch
Update project branch
NEON_UPDATE_PROJECT_BRANCHUpdates 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.Input Parameters
Output
Update project compute endpoint settings
Update project compute endpoint settings
NEON_UPDATE_PROJECT_COMPUTE_ENDPOINT_SETTINGSUpdates 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.Input Parameters
k8s-neonvm supports autoscaling; k8s-pod is fixed-size. Neon also accepts docker and serverless-platform.0 means use the global default. The value -1 means never suspend. The default value is 300 seconds (5 minutes). The minimum value is 60 seconds (1 minute). The maximum value is 604800 seconds (1 week). For more information, see Auto-suspend configuration.Output
Update project settings by id
Update project settings by id
NEON_UPDATE_PROJECT_SETTINGS_BY_IDUpdates 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.Input Parameters
0 means use the global default. The value -1 means never suspend. The default value is 300 seconds (5 minutes). The minimum value is 60 seconds (1 minute). The maximum value is 604800 seconds (1 week). For more information, see Auto-suspend configuration.Output
Update project snapshot
Update project snapshot
NEON_UPDATE_PROJECTS_SNAPSHOTSTool 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.