Team
Shared credential for production and unattended runs.
Connect Neon with Hookshot™ and your stack
Postgres, on a serverless platform designed to help you build reliable and scalable applications faster
Tools and triggers
What Agents can do in Neon
Available tools and events after Neon is connected.
-
Accept Project Transfer Request
Tool to accept a transfer request for a Neon project. Use when you need to accept an existing transfer request to transfer a project to your account or a specific organization.
-
Access Project Details by Id
Retrieves detailed information about a specific Neon serverless Postgres project. Returns comprehensive project data including configuration, database settings, compute resources, owner information, and consumption…
-
Add New Jwks to Project Endpoint
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…
-
Add Project Email Permission
Adds permissions for a specified email address to a particular project within the Neon B2B SaaS integration platform. This endpoint is used to grant access or specific rights to users for a given project, enabling…
-
Add Role to Branch
Creates a new PostgreSQL role within a specific branch of a Neon project. Neon is a serverless PostgreSQL platform where roles are database-level users that can connect to the database and have specific permissions…
-
Assign or Update VPC Endpoint
Assigns an AWS VPC endpoint to a Neon organization for Private Networking, or updates the label of an existing VPC endpoint assignment. This enables secure, private database connections through AWS PrivateLink without…
-
Count Project Branches
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.
-
Create Anonymized Branch
Creates a new branch with anonymized data using PostgreSQL Anonymizer for static masking. Use when developers need to work with masked production data in a safe development environment.
-
Create API Key for Organization
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…
-
Create Auth Provider SDK 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.
-
Create Auth User
Tool to create a new user in Neon Auth for a specific project branch. Use when you need to add authentication users to a branch that has Neon Auth enabled with the 'stack' provider. The branch must already have Neon…
-
Create Branch Database
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…
-
Create Branch Snapshot
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…
-
Create Compute Endpoint
Creates a new compute endpoint for a specified branch within a Neon project. This endpoint allows for detailed configuration of database resources, including read/write capabilities, regional placement, autoscaling…
-
Create Neon Data API
Creates a new instance of Neon Data API in the specified branch. The Data API provides a RESTful interface to query your Postgres database using HTTP requests. Use this action when you need to expose database access…
-
Create New API Key
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…
-
Create New Project Branch
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…
-
Create Project Transfer Request
Tool to create a transfer request for a Neon project. Use when you need to transfer a project to another account or organization. The transfer request has an expiration time after which it can no longer be used.
-
Create Project with Quota and Settings
Creates a new Neon project with specified configuration settings. This endpoint allows you to set up a customized PostgreSQL environment with various options for resource management, networking, and performance…
-
Delete Api Key by Id
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…
-
Delete Auth Domains
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.
-
Delete Auth User
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…
-
Delete Branch Data API
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.
-
Delete Database From Branch
Deletes a specific database from a designated branch within a project in the Neon platform. This endpoint should be used when you need to permanently remove a database and all its associated data from a particular…
-
Delete OAuth Provider
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, or Vercel) from the given branch. Use this…
-
Delete Organization Api Key
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…
-
Delete Organization Member
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…
-
Delete Project Branch by Id
Deletes a specific branch within a project in the Neon B2B SaaS integration platform. This endpoint permanently removes the specified branch and all associated data from the project. It should be used when a branch is…
-
Delete Project Branch Role
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…
-
Delete Project by Id
Permanently deletes a Neon PostgreSQL project and all its associated resources. WARNING: This is a destructive operation that cannot be undone. All data, branches, endpoints, databases, and configurations will be…
-
Delete Project Endpoint
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…
-
Delete Project Jwks by Id
Deletes a specific JSON Web Key Set (JWKS) associated with a given project in the Neon B2B SaaS integration platform. This endpoint is used to remove outdated or unnecessary cryptographic keys from a project's key…
-
Delete Project Permission
Deletes a specific permission associated with a project in the Neon B2B SaaS integration platform. This endpoint is used to remove access rights or privileges from a project, which is crucial for maintaining proper…
-
Delete Project Snapshot
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.
-
Delete Vpc Endpoint by Ids
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…
-
Delete Vpc Endpoint by Project Id
Deletes a specific VPC endpoint within a designated project in the Neon platform. This endpoint should be used when you need to remove a VPC endpoint that is no longer required or has become obsolete. The operation is…
-
Disable Branches Auth
Tool to disable Neon Auth for a specific branch in a Neon project. Use when you need to remove authentication integration for a branch. This operation can optionally delete the `neon_auth` schema from the database by…
-
Enable Neon Auth for Branch
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.
-
Fetch Database for Branch
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…
-
Fetch Organization Members by Id
Retrieves a list of all members associated with a specific organization in the Neon B2B SaaS integration platform. This endpoint allows you to fetch detailed information about the users or entities that belong to the…
-
Fetch Vpcendpoint Details by Id
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…
-
Finalize Branch Restore
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)…
-
Get Auth
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…
-
Get Auth Allow Localhost
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.
-
Get Auth Email Provider
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…
-
Get Available Preload Libraries
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…
-
Get Branch Roles for Project
Retrieves the roles associated with a specific branch within a project in the Neon B2B SaaS integration platform. This endpoint is used to fetch the current role assignments for a given project and branch combination…
-
Get Branches Anonymized Status
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…
-
Get Branches Backup Schedule
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…
-
Get Branches for Project
Retrieves a list of branches associated with a specific project in the Neon B2B SaaS integration platform. This endpoint should be used when you need to get an overview of all branches within a particular project…
-
Get Branches Masking Rules
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…
-
Get Consumption History Projects
Retrieves consumption history for projects within a Neon organization. IMPORTANT: This endpoint is only available for Scale, Business, and Enterprise plan accounts. Free and Launch plans do not have access to this…
-
Get Current User Information
Retrieves the profile information for the currently authenticated user. This endpoint should be used when you need to access details about the user making the API request, such as their username, email, or other…
-
Get Neon Data API for Branch
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.
-
Get Organization Api Keys
Retrieves a list of all API keys associated with a specific organization in the Neon B2B SaaS integration platform. This endpoint is crucial for administrators to manage and monitor API access within their…
-
Get Project Branch Role
Retrieves detailed information about a specific role within a particular branch of a Neon project. This endpoint is used to fetch the current configuration, permissions, and other relevant details associated with the…
-
Get Project Branch Schema Comparison
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…
-
Get Project Branches
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…
-
Get Project Connection Uri
Retrieves the connection URI for a specified project within the Neon B2B SaaS integration platform. This endpoint is crucial for establishing connectivity to a project's resources, enabling access to its data and…
-
Get Project Endpoint Information
Retrieves a list of all compute endpoints associated with a specific Neon project. Compute endpoints are the connection points for your Neon PostgreSQL databases. Use this action to get information about endpoint…
-
Get Project Operation by Id
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…
-
Get Schema for Project Branch
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…
-
Get User Organizations
Retrieves a list of organizations associated with the currently authenticated user in the Neon platform. This endpoint allows users to view all the organizations they are a member of, providing essential information…
-
Get Vpc Region Endpoints
Retrieves a list of VPC endpoints for a specified organization within a particular AWS region. This endpoint allows developers to obtain information about the virtual network interfaces that enable private…
-
List Api Keys
Retrieves a list of API keys associated with the authenticated user's Neon account. This endpoint allows developers to view and manage their existing API keys, which are crucial for authentication when making requests…
-
List Auth Domains
Lists the domains in the redirect_uri whitelist for the specified project and branch. Use when you need to retrieve or verify the allowed domains for authentication redirects.
-
List Auth OAuth Providers
Retrieves the OAuth providers configured for Neon Auth on a specific branch. Use this when you need to view the available OAuth authentication providers for a given project and branch combination. This is useful for…
-
List Project Snapshots
Tool to list all snapshots for a specified Neon project. Use when you need to view available snapshots for backup, restore, or data recovery purposes. **Note**: This endpoint is currently in Beta.
-
List Shared Projects
Retrieves a list of Neon Postgres projects shared with your account. Returns projects that other users have granted you access to, along with pagination info. Use this to view and manage collaborative database…
-
List VPC Endpoints for Organization
Tool to retrieve the list of VPC endpoints for a specified Neon organization across all regions. Use when you need to view or audit all VPC endpoints associated with an organization.
-
Modify Branch Details in Project
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…
-
Patch Branch Database Information
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…
-
Reset Role Password for Branch
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…
-
Restart Project Endpoint
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…
-
Restore Project Branch
This endpoint restores a branch to a specific state or point in time. Use it to recover data, revert changes, or create new branch states based on historical data. The restoration uses either a Log Sequence Number…
-
Restore Snapshot to New Branch
Tool to restore a Neon snapshot to a new branch. Use when you need to recover data from a snapshot or create a branch from a previous point in time. This endpoint is currently in Beta.
-
Retrieve Account Consumption History
Retrieves the consumption history for a specified account within the Neon platform. This endpoint provides detailed information about resource usage and associated costs over a given time period. It's particularly…
-
Retrieve All Regions
Retrieves a list of available geographic regions supported by the Neon B2B SaaS integration platform. This endpoint provides crucial information about the different areas where the API is accessible and optimized for…
-
Retrieve Branch Database Details
Retrieves detailed information about a specific database within a Neon project and branch. This endpoint allows developers to fetch crucial metadata and configuration details for a given database, enabling them to…
-
Retrieve Branch Endpoints
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…
-
Retrieve Jwks for Project
Retrieves the JSON Web Key Set (JWKS) for a specified project. This endpoint should be used when a client needs to obtain the public keys necessary for verifying JSON Web Tokens (JWTs) issued by the project. The JWKS…
-
Retrieve Organization by Id
Retrieves detailed information about a specific organization within the Neon platform. This endpoint allows you to access comprehensive data about an organization, including its configuration, members, and associated…
-
Retrieve Organization Invitations
Retrieves a list of all pending invitations for a specified organization. This endpoint allows organization administrators to view and manage outstanding invitations sent to potential new members. It should be used…
-
Retrieve Organization Member Info
Retrieves detailed information about a specific member within an organization in the Neon B2B SaaS integration platform. This endpoint allows you to fetch comprehensive data about an individual member, including their…
-
Retrieve Project Endpoint Details
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…
-
Retrieve Project Operations
Retrieves a list of operations associated with a specific project in the Neon B2B SaaS integration platform. This endpoint should be used when you need to fetch all operations related to a particular project, such as…
-
Retrieve Project Permissions
Retrieves the current permissions settings for a specific project within the Neon B2B SaaS integration platform. This endpoint allows users to view the access rights and roles assigned to various users or entities for…
-
Retrieve Projects List
Retrieves a list of all Neon projects associated with the authenticated user's account. This endpoint provides a comprehensive overview of the user's projects, enabling efficient project management and integration…
-
Retrieve Vpc Endpoints for Project
Retrieves a list of VPC (Virtual Private Cloud) endpoints associated with a specific project in the Neon B2B SaaS integration platform. This endpoint allows developers to fetch information about private network…
-
Reveal Role Password in Branch
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…
-
Send Auth Test Email
Tool to send a test email using specified SMTP configuration for Neon Auth. Use when validating SMTP settings or testing email delivery for Neon Auth integration on a specific branch.
-
Send Organization Invitations
Creates and sends invitations to join an organization in the Neon B2B SaaS integration platform. This endpoint allows administrators to invite multiple users simultaneously, specifying their email addresses and…
-
Set Branch as Default
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…
-
Set VPC Endpoint Restriction
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…
-
Start Branch Anonymization
Starts the anonymization process for an anonymized branch that is in the initialized, error, or anonymized state. This will apply all defined masking rules to anonymize sensitive data in the branch databases. The…
-
Start Endpoint for Project
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…
-
Suspend Project Endpoint by Id
Suspends a specific endpoint within a project in the Neon B2B SaaS integration platform. This operation temporarily disables the endpoint, preventing it from processing further requests until it is resumed. Use this…
-
Transfer Projects Between Organizations
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…
-
Transfer User Projects to Organization
Transfers multiple projects from the authenticated user's personal account to a specified organization within the Neon B2B SaaS integration platform. This endpoint allows for bulk transfer of projects, enabling…
-
Update Auth Allow Localhost
Updates the allow localhost configuration for a specific branch in a Neon project. This endpoint controls whether connections from localhost are permitted to the branch. Use this when you need to enable or disable…
-
Update Branch Auth Email Provider
Updates the email provider configuration for a specific branch's authentication system. Currently, the Neon API only supports the 'shared' email provider type. To use this action, provide only sender_email and…
-
Update Branches Data API
Updates the Neon Data API configuration for the specified branch. Use when you need to modify Data API settings such as aggregates, anonymous role, search paths, schemas, JWT settings, or CORS configuration. The schema…
-
Update Branches Masking Rules
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…
-
Update Organization Member Role
Updates the role of a specific member within an organization in the Neon B2B SaaS integration platform. This endpoint allows changing a member's role between 'admin' and 'member', which affects their permissions and…
-
Update Project Compute Endpoint Settings
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…
-
Update Project Settings by Id
Updates the configuration and settings of a specific Neon project. This endpoint allows fine-grained control over various aspects of a project, including resource quotas, security settings, maintenance windows, and…
-
Update Project Snapshot
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.
Setup
Connect Neon in Hookshot™
Pick a scope, then confirm what can start a Protege and what it can do.
Trigger Access
What can start a Protege from this app.
Tool Access
What a Protege can do after it starts.
Connection scope
Prefer team for production.
Personal
Tied to one user—only when the workflow needs their account.
Chat
Team-scoped for supported chat surfaces.
Build with us
See Hookshot™ in your stack.
Request early access or book a live walkthrough with the team.
