Skip to main content
Neon logo
  • Category: databases
  • Auth: API_KEY, OAUTH2
  • Composio-managed OAuth available? No
  • Tools: 110
  • Triggers: 0
  • Slug: NEON
  • Version: 20261101_00

Tools

Slug: 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

string
The Neon organization ID to transfer the project to (e.g., ‘org-holy-recipe-01602027’). If not provided, the project will be transferred to the current user or organization account.
string
required
The Neon project ID (e.g., ‘small-recipe-63664710’). Obtain via NEON_RETRIEVE_PROJECTS_LIST action.
string
required
The Neon project transfer request ID (e.g., ‘a321073e-3947-4545-bf4a-c6d5835226e7’). Obtain via NEON_CREATE_PROJECTS_TRANSFER_REQUESTS action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEON_COUNT_PROJECT_BRANCHESTool 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.

Input Parameters

Count branches matching the name in search query
string
required
The Neon project ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A user-specified name for the API key (e.g., ‘production-backend’, ‘ci-cd-pipeline’). Used to identify the key in the Neon console. Must be non-empty.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The Neon organization ID. Can be found in the Organization Settings page.
string
required
A user-specified name for the API key. Maximum length: 64 characters. This name helps identify and manage the key.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The Neon project ID (e.g., ‘proud-meadow-87189985’). Must match the pattern: lowercase letters, numbers, and hyphens, 1-60 characters. You can obtain the project_id by listing the projects for your Neon account.
string ("mock" | "stack" | "stack_v2" | "better_auth")
required
The authentication provider to create SDK keys for. Options: ‘mock’ (for testing), ‘stack’ (Stack Auth v1), ‘stack_v2’ (Stack Auth v2), ‘better_auth’ (Better Auth).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The display name for the new auth user. Required field, max 255 characters.
string
required
The email address for the new auth user. Must be a valid email format and between 1-256 characters.
string
required
The branch ID where the auth user will be created (e.g., ‘br-lucky-water-afkw1lov’). The branch must have Neon Auth enabled. Obtain via NEON_GET_BRANCHES_FOR_PROJECT action.
string
required
The Neon project ID (e.g., ‘dry-smoke-26258271’). Obtain via NEON_RETRIEVE_PROJECTS_LIST action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The branch ID where the database will be created (e.g., ‘br-lucky-water-afkw1lov’). Obtain via NEON_GET_BRANCHES_FOR_PROJECT action.
string
required
The name of an existing role that will own the database (e.g., ‘neondb_owner’). Obtain available roles via NEON_GET_BRANCH_ROLES_FOR_PROJECT action.
string
required
The Neon project ID (e.g., ‘dry-smoke-26258271’). Obtain via NEON_RETRIEVE_PROJECTS_LIST action.
string
required
The name of the database to create. Must be a valid PostgreSQL database name (lowercase letters, numbers, underscores; max 63 characters).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The Neon branch ID (e.g., ‘br-gentle-lab-af8riisw’). You can obtain the branch_id by listing the branches for your project.
string
required
The Neon project ID (e.g., ‘small-recipe-63664710’). You can obtain the project_id by listing the projects for your Neon account.
string ("mock" | "stack" | "stack_v2" | "better_auth")
required
The authentication provider to enable for the branch. Must be one of: mock, stack, stack_v2, or better_auth.
string
The name of the database to use for authentication. If not specified, the default database will be used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
The URL that lists the JWKS (JSON Web Key Set) for external authentication. Required when auth_provider is ‘external’.
object
Configuration settings for the Neon Data API
string
required
The branch ID where the Data API will be created (e.g., ‘br-muddy-pond-ahkofech’). Obtain via NEON_GET_BRANCHES_FOR_PROJECT action.
string
required
The Neon project ID (e.g., ‘proud-meadow-87189985’). Obtain via NEON_RETRIEVE_PROJECTS_LIST action.
string
JWT audience claim to validate. WARNING: tokens without audience claim will still be accepted.
string ("neon_auth" | "external")
Authentication provider options for Neon Data API
string
required
The database name for the Data API (e.g., ‘neondb’). Must be an existing database in the branch.
string
The name of the authentication provider (e.g., ‘Clerk’, ‘Stytch’, ‘Auth0’). Used for documentation purposes.
boolean
Skip creating the auth schema and RLS functions. Default: false
boolean
Grant all permissions to the tables in the public schema to authenticated users. Default: false

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Target Log Sequence Number (LSN) for the snapshot (e.g., ‘0/19A3328’). Cannot be used together with timestamp parameter.
string
Name for the snapshot (e.g., ‘test-snapshot-root-branch’). If not provided, an auto-generated name will be used.
string
required
The branch ID from which to create the snapshot (e.g., ‘br-lucky-water-afkw1lov’). Obtain via NEON_GET_BRANCHES_FOR_PROJECT action.
string
Target timestamp for the snapshot in ISO 8601 format (e.g., ‘2026-02-15T12:00:00Z’). Cannot be used together with lsn parameter.
string
Expiration time for the snapshot in ISO 8601 format (e.g., ‘2026-08-13T00:00:00Z’). After this time, the snapshot will be automatically deleted.
string
required
The Neon project ID (e.g., ‘dry-smoke-26258271’). Obtain via NEON_RETRIEVE_PROJECTS_LIST action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

boolean
Whether to restrict connections to the compute endpoint. Enabling this option schedules a suspend compute operation. A disabled compute endpoint cannot be enabled by a connection or console action. However, the compute endpoint is periodically enabled by check_availability operations.
string
required
The ID of the branch the compute endpoint will be associated with
string
The region where the compute endpoint will be created. Only the project”s region_id is permitted.
string
required
The Neon project ID
object
A raw representation of Postgres settings
string ("transaction")
The connection pooler mode. Neon supports PgBouncer in transaction mode only.
string ("k8s-pod" | "k8s-neonvm" | "docker" | "serverless-platform")
The Neon compute provisioner. Specify the k8s-neonvm provisioner to create a compute endpoint that supports autoscaling. Documented values are k8s-pod, k8s-neonvm, docker, and serverless-platform.
string ("read_only" | "read_write")
required
The compute endpoint type. Either read_write or read_only.
boolean
Whether to enable connection pooling for the compute endpoint
object
A raw representation of PgBouncer settings
boolean
NOT YET IMPLEMENTED by Neon. Retained for backward compatibility; setting this field may have no effect.
integer
Duration of inactivity in seconds after which the compute endpoint is automatically suspended. The value 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.
number
Maximum compute units for autoscaling. Must be at least 0.25 and not less than the minimum.
number
Minimum compute units for autoscaling. Must be at least 0.25.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The Neon project ID. You can find this on the Settings page in the Neon Console or by listing projects. Format: ‘adjective-noun-12345678’ (e.g., ‘autumn-disk-484331’).
string
Name for the new branch. If not specified, an auto-generated name will be used (e.g., ‘br-square-base-aehfbgdy’). Max 256 characters.
string ("parent-data" | "parent-schema" | "schema-only" | "import")
How to initialize the branch: parent-data (default), parent-schema, schema-only, or import.
string
The branch ID to use as parent for the new branch. If not specified, the project’s default branch (usually ‘main’) is used. Format: ‘br-name-id’ (e.g., ‘br-wispy-dew-591433’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The Neon project ID where the anonymized branch will be created.
object
Configuration for creating the new branch
array
Optional list of masking rules to apply to the branch. Each rule specifies how to anonymize a specific column using PostgreSQL Anonymizer functions.
object
Optional metadata annotations to attach to the branch.
boolean
If true, automatically starts the anonymization process after branch creation. If false or omitted, masking rules are stored but not applied until manually triggered.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

boolean
Set true to create a role that cannot log in. Such a role has no generated login password.
string
required
The branch ID where the role will be created (e.g., ‘br-icy-cake-aebdped3’). The branch must have a compute endpoint.
string
required
The PostgreSQL role name to create. Must be a valid PostgreSQL identifier and cannot exceed 63 bytes in length. Common examples: ‘admin’, ‘readonly_user’, ‘app_service’.
string
required
The Neon project ID (e.g., ‘calm-breeze-57229290’). Obtain this from the list projects endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A valid HTTPS URL that returns a JSON Web Key Set (JWKS) for JWT verification. Examples: https://www.googleapis.com/oauth2/v3/certs (Google), https://login.microsoftonline.com/common/discovery/v2.0/keys (Microsoft), https://appleid.apple.com/auth/keys (Apple).
string
The Neon branch ID to associate the JWKS with. If omitted, the JWKS applies to all branches in the project.
string
required
The Neon project ID
array
List of database role names that the JWKS should be mapped to. If omitted, defaults to authenticator, authenticated, and anonymous roles. Maximum of 10 role names allowed.
string
The required ‘aud’ (audience) claim value that must be present in JWTs for authentication. Used to ensure tokens are intended for your specific application.
string
required
The name of the authentication provider (e.g., Clerk, Stytch, Auth0)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The email address of the user to grant project access to. The user will receive access to the project associated with this email address. Must be a valid email format (e.g., ‘user@example.com’).
string
required
The unique identifier of the Neon project to grant access to. Project IDs follow the pattern of lowercase alphanumeric characters with hyphens (e.g., ‘dry-smoke-26258271’). You can obtain this from the project list or project details.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The Neon project ID (e.g., ‘small-recipe-63664710’). Obtain via NEON_RETRIEVE_PROJECTS_LIST action.
integer
Specifies the validity duration of the transfer request in seconds. If not provided, the request will expire after 24 hours (86,400 seconds).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Organization id in case the project created belongs to an organization. If not present, project is owned by a user and not by org.
string
The region identifier. Refer to our Regions documentation for supported regions. Values are specified in this format: aws-us-east-1
string
The role name. If not specified, the default role name, {database_name}_owner, will be used.
integer ("14" | "15" | "16" | "17" | "18" | "19")
The Postgres major version. Neon supports 14 through 18; version 19 is available only in enabled regions.
array
A list of IP addresses that are allowed to connect to the endpoint.
string
The default branch name. If not specified, the default branch name, main, will be used.
object
A raw representation of Postgres settings
string ("k8s-pod" | "k8s-neonvm" | "docker" | "serverless-platform")
The Neon compute provisioner. Specify the k8s-neonvm provisioner to create a compute endpoint that supports Autoscaling. Supported values are k8s-pod, k8s-neonvm, docker, and serverless-platform.
string
The project name
string
The database name. If not specified, the default database name, neondb, will be used.
boolean
Whether or not passwords are stored for roles in the Neon project. Storing passwords facilitates access to Neon features that require authorization.
object
A raw representation of PgBouncer settings
string
End time of the maintenance window, in the format of “HH:MM”. Uses UTC.
array
A list of weekdays when the maintenance window is active. Encoded as ints, where 1 - Monday, and 7 - Sunday.
boolean
When set, connections using VPC endpoints are disallowed. This parameter is under active development and its semantics may change in the future.
string
Start time of the maintenance window, in the format of “HH:MM”. Uses UTC.
integer
Duration of inactivity in seconds after which the compute endpoint is automatically suspended. The value 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.
number
Autoscaling Limit Max Cu
number
Autoscaling Limit Min Cu
boolean
When set, connections from the public internet are disallowed. This supersedes the AllowedIPs list. This parameter is under active development and its semantics may change in the future.
integer
Limit on the logical size of every project”s branch.
integer
Total amount of data written to all of a project”s branches.
integer
The number of seconds to retain the shared history for all branches in this project. The default is 1 day (86400 seconds).
integer
The total amount of wall-clock time allowed to be spent by the project”s compute endpoints.
integer
Total amount of data transferred from all of a project”s branches using the proxy.
boolean
Sets wal_level=logical for all compute endpoints in this project. All active endpoints will be suspended. Once enabled, logical replication cannot be disabled.
integer
The total amount of CPU seconds allowed to be spent by the project”s compute endpoints.
number
Autoscaling Limit Max Cu
number
Autoscaling Limit Min Cu
boolean
If true, the list will be applied only to protected branches.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A descriptive label for the VPC endpoint restriction. Used for identification and organization purposes. Example: ‘Production VPC’ or ‘Dev Environment’.
string
required
The Neon project ID. Must match pattern ^[a-z0-9-]{1,60}$. Example: ‘dry-smoke-26258271’.
string
required
The AWS VPC endpoint ID to restrict connections to. Must start with ‘vpce-’ prefix followed by alphanumeric characters. Example: ‘vpce-0f00567fa8EXAMPLE’. The VPC endpoint must first be assigned to the organization before it can be used as a project restriction.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A descriptive label for the VPC endpoint to help identify it within your organization (e.g., ‘production-vpc’, ‘staging-database’).
string
required
The Neon organization ID (e.g., ‘org-bold-bonus-12345678’). Required for organizations on Business or Enterprise plans.
string
required
The AWS region ID where the VPC endpoint is located (e.g., ‘aws-us-east-1’, ‘aws-us-east-2’, ‘aws-eu-central-1’). Note: Azure regions are not supported for VPC endpoints.
string
required
The AWS VPC endpoint ID to assign to the Neon organization (e.g., ‘vpce-0123456789abcdef0’). This must be a valid VPC endpoint created in your AWS account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The numeric ID of the API key to delete. You can obtain this ID from the list_api_keys action. Example: 2690219

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
required
Array of domain objects to remove from the redirect_uri whitelist. Each domain must include the full URL with protocol.
string
required
The unique identifier for the Neon project (e.g., ‘proud-meadow-87189985’). Can be obtained from the list projects API.
string ("mock" | "stack" | "stack_v2" | "better_auth")
required
The authentication provider for which to remove the domain from the redirect_uri whitelist.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique branch identifier within the project (e.g., ‘br-lucky-water-afkw1lov’). Can be retrieved using the list project branches endpoint.
string
required
The unique identifier for the Neon project. Format: alphanumeric with hyphens (e.g., ‘dry-smoke-26258271’). Can be found in the Neon console or via the list projects API.
string ("google" | "github" | "microsoft" | "vercel")
required
The OAuth provider ID to delete: google, github, microsoft, or vercel.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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 project

Input Parameters

string
required
The Neon branch ID. Format: ‘br-’ prefix followed by alphanumeric characters (e.g., ‘br-lucky-water-afkw1lov’). Can be obtained from the list branches endpoint.
string
required
The Neon project ID. Format: alphanumeric with hyphens (e.g., ‘dry-smoke-26258271’). Can be obtained from the list projects endpoint.
string
required
The Neon user ID to delete. Format: UUID (e.g., ‘f7a03453-e0c9-4c66-96ca-aee5e7936654’). This identifies the specific auth user to remove from the branch.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
required
Array of domain objects to remove from the redirect_uri whitelist
string
required
The Neon branch ID (e.g., ‘br-lucky-water-afkw1lov’)
string
required
The Neon project ID (e.g., ‘dry-smoke-26258271’)
string ("mock" | "stack" | "stack_v2" | "better_auth")
required
The authentication provider for which to delete the domains

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The branch ID. Format: ‘br-’ prefix followed by alphanumeric characters (e.g., ‘br-rough-voice-ah2lazzk’). Obtain from list branches endpoint.
string
required
The Neon project ID. Format: {adjective}-{noun}-{number} (e.g., ‘proud-meadow-87189985’). Obtain from list projects endpoint.
string
required
The database name for which to delete the Neon Data API. This is the database name as it appears in PostgreSQL (e.g., ‘neondb’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier for the branch within the project. Format: ‘br-’ prefix followed by alphanumeric characters (e.g., ‘br-lucky-water-afkw1lov’). Can be obtained from the list branches API.
string
required
The unique identifier for the Neon project. Format: alphanumeric with hyphens (e.g., ‘dry-smoke-26258271’). Can be found in the Neon console or via the list projects API.
string
required
The name of the database to delete. This is the database name as it appears in PostgreSQL, not an ID. The deletion is permanent and cannot be undone.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique integer identifier of the API key to delete. This ID is returned when creating an API key or can be obtained from the list organization API keys endpoint.
string
required
The Neon organization ID. Format: ‘org-<adjective>-<noun>-<number>’ (e.g., ‘org-cool-breeze-12345678’). Can be obtained from the get user organizations endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The Neon organization ID. Format: ‘org-<name>-<id>’ (e.g., ‘org-my-company-12345678’). Can be retrieved using the get_user_organizations action.
string
required
The unique identifier of the organization member to remove. Must be a valid UUID format (e.g., ‘46bbb36a-8e45-4f4a-93c0-03e39ca4204e’). Can be retrieved using the fetch_organization_members_by_id action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The branch ID
string
required
The Neon project ID
boolean
If true, permanently deletes the branch immediately. If false, the branch can be recovered within seven days. Omit this preview parameter unless the account supports Branch Recovery.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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 database

Input Parameters

string
required
The unique branch identifier within the project (e.g., ‘br-rough-voice-ah2lazzk’). Can be retrieved using the list project branches endpoint.
string
required
The name of the PostgreSQL role to delete from the branch (e.g., ‘my_app_user’). Cannot exceed 63 bytes in length. Note: Deleting a role is permanent and cannot be undone.
string
required
The unique Neon project identifier (e.g., ‘proud-meadow-87189985’). Can be retrieved using the list projects endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique Neon project ID to delete. This is a string identifier in the format ‘adjective-noun-number’ (e.g., ‘cool-breeze-12345678’). Can be obtained from project creation or list projects API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The Neon project ID. Format: {adjective}-{noun}-{number} (e.g., ‘dry-smoke-26258271’). Obtain from NEON_RETRIEVE_PROJECTS_LIST.
string
required
The compute endpoint ID to delete. Format: ep-{name}-{id} (e.g., ‘ep-flat-mud-af9isowb’). Obtain from NEON_GET_PROJECT_ENDPOINT_INFORMATION.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEON_DELETE_PROJECT_JWKS_BY_IDPermanently deletes a JWKS configuration from a Neon project. JWT authentication that depends on the removed configuration may stop working.

Input Parameters

string
required
The JWKS ID
string
required
The Neon project ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the Neon project. Format: lowercase-words-numbers (e.g., ‘dry-smoke-26258271’). Can be obtained from the projects list endpoint.
string
required
The unique identifier (UUID) of the permission to revoke. Format: UUID (e.g., ‘92a6ce17-b30d-40ce-aa30-bd0d1dc0de1c’). Can be obtained from the project permissions list endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The Neon project ID. Format: alphanumeric with hyphens (e.g., ‘proud-meadow-87189985’). Can be obtained from the list projects API.
string
required
The snapshot ID. Format: ‘snap-’ prefix followed by alphanumeric characters (e.g., ‘snap-wispy-union-ahw80v1u’). Can be obtained from the list snapshots API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The Neon organization ID (e.g., ‘org-abc-123’). This can be obtained from the get_user_organizations action.
string
required
The AWS region ID where the VPC endpoint is located. Must be an AWS region (e.g., ‘aws-us-east-1’, ‘aws-eu-central-1’). Azure regions are not supported for VPC endpoints.
string
required
The AWS VPC endpoint ID to delete (e.g., ‘vpce-0abc123def456789’). This is the VPC endpoint ID from your AWS account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEON_DELETE_VPC_ENDPOINT_BY_PROJECT_IDRemoves 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.

Input Parameters

string
required
The Neon project ID
string
required
The VPC endpoint ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEON_DISABLE_BRANCHES_AUTHDisables 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.

Input Parameters

string
required
The Neon branch ID
string
required
The Neon project ID
boolean
If true, deletes the neon_auth schema from the database

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Used to rename the existing branch when it is replaced. If omitted, a default name is generated and used.
string
required
The ID of the branch created from a snapshot that will be finalized. Format: ‘br-adjective-noun-alphanumeric’ (e.g., ‘br-late-voice-ahlrw52f’).
string
required
The Neon project ID. Format: ‘adjective-noun-12345678’ (e.g., ‘proud-meadow-87189985’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
End date-time for the consumption period, rounded to the requested granularity.
string
required
Start date-time for the consumption period, rounded to the requested granularity.
integer
Maximum number of projects to return per page.
string
Cursor from the previous response for the next page of projects.
string
required
Organization whose project consumption metrics should be returned.
array
required
Consumption metrics to include in the response.
string ("hourly" | "daily" | "monthly")
required
Granularity of the returned metrics: hourly, daily, or monthly.
array
Optional project IDs to include. Omit to include all projects in the organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEON_GET_AUTH_ALLOW_LOCALHOSTRetrieves 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.

Input Parameters

string
required
The Neon branch ID
string
required
The Neon project ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the branch within the project (e.g., ‘br-lucky-water-afkw1lov’). You can obtain this from the list branches endpoint.
string
required
The unique Neon project ID. This is a string identifier in the format ‘adjective-noun-number’ (e.g., ‘dry-smoke-26258271’). You can obtain project IDs by listing projects using the retrieve_projects_list action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEON_GET_BRANCH_DATABASEReturns metadata and configuration for one database in a project branch without modifying the database.

Input Parameters

string
required
The branch ID
string
required
The Neon project ID
string
required
The database name

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The branch ID. You can obtain the branch_id by listing the project’s branches. Only anonymized branches will have status information available.
string
required
The Neon project ID. You can obtain a project_id by listing the projects for your Neon account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The branch ID
string
required
The Neon project ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEON_GET_BRANCHES_DATA_APIRetrieves 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.

Input Parameters

string
required
The Neon branch ID
string
required
The Neon project ID
string
required
The database name

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The branch ID. You can obtain this by listing the project’s branches.
string
required
The Neon project ID. You can obtain this by listing the projects for your Neon account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The Neon organization ID. Format: ‘org-xxxx-xxxx-xxxxxxxx’. Use the ‘get_user_organizations’ action to list available organization IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEON_GET_ORGANIZATION_MEMBERReturns one organization’s member record, including the associated user ID, organization role, and join timestamp.

Input Parameters

string
required
The Neon organization ID (e.g., ‘org-holy-recipe-01602027’). Can be obtained from the Get User Organizations endpoint.
string
required
The Neon organization member ID (UUID format, e.g., ‘46bbb36a-8e45-4f4a-93c0-03e39ca4204e’). Can be obtained from the Fetch Organization Members endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique Neon project ID. This is a string identifier in the format ‘adjective-noun-number’ (e.g., ‘dry-smoke-26258271’). You can obtain project IDs by listing projects using the retrieve_projects_list action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The branch ID
string
required
The Neon project ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the branch within the project (e.g., ‘br-lucky-water-afkw1lov’). You can obtain this from the list branches endpoint.
string
required
The name of the database role to retrieve (e.g., ‘neondb_owner’, ‘authenticator’, ‘authenticated’, ‘anonymous’). This is the PostgreSQL role name within the branch.
string
required
The unique identifier of the Neon project (e.g., ‘dry-smoke-26258271’). You can obtain this from the list projects endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Optional Log Sequence Number (LSN) for which the schema is retrieved. Format: ‘X/XXXXXXXX’ (e.g., ‘0/1F79928’).
string
required
Name of the database for which the schema is compared (e.g., ‘neondb’). Can be obtained from the databases list for a branch.
string
Optional Log Sequence Number (LSN) for the base branch schema. Format: ‘X/XXXXXXXX’.
string
required
The branch ID to get the schema from (e.g., ‘br-calm-bread-ah40d54d’). Can be obtained from the branches list for a project.
string
Optional ISO 8601 timestamp for the point in time for which the schema is retrieved (e.g., ‘2022-11-30T20:09:48Z’).
string
required
The Neon project ID (e.g., ‘proud-meadow-87189985’). Can be obtained from the project list or project details.
string
Optional branch ID to compare the schema with. If not specified, compares with the parent branch.
string
Optional ISO 8601 timestamp for the point in time for the base branch schema (e.g., ‘2022-11-30T20:09:48Z’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

boolean
Adds the -pooler option to the connection URI when set to true, creating a pooled connection URI.
string
The branch ID. Defaults to the project’s default branch_id if not specified. The branch must have an associated compute endpoint.
string
required
The PostgreSQL role name to use for authentication (e.g., ‘neondb_owner’).
string
required
The Neon project ID
string
The compute endpoint ID (starts with ‘ep-’). Defaults to the read-write endpoint associated with the branch_id if not specified. Required if the branch has multiple endpoints or no default read-write endpoint.
string
required
The name of the database to connect to within the branch (e.g., ‘neondb’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier for a Neon project (e.g., ‘dry-smoke-26258271’). Can be obtained from the projects list endpoint or project details.
string
required
The unique identifier of the compute endpoint (e.g., ‘ep-empty-bush-af3x7l26’). Endpoint IDs start with ‘ep-’ prefix. Can be obtained from the list endpoints action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The Neon project ID (e.g., ‘dry-smoke-26258271’). Can be obtained from the list projects endpoint.
string
required
The unique identifier (UUID) of the operation to retrieve (e.g., ‘f3bcadce-07ac-4c2f-8dae-182d02da1518’). Can be obtained from the list project operations endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Optional Log Sequence Number (LSN) to retrieve the schema at a specific point in the WAL. Format: ‘X/XXXXXXXX’ (e.g., ‘0/1F79928’). If not specified, returns the current schema.
string
required
Name of the database to retrieve schema for (e.g., ‘neondb’). Can be obtained from the databases list for a branch.
string
required
The branch ID (e.g., ‘br-lucky-water-afkw1lov’). Can be obtained from the branches list for a project.
string
Optional ISO 8601 timestamp to retrieve the schema at a specific point in time (e.g., ‘2025-07-26T17:44:06Z’). If not specified, returns the current schema.
string
required
The Neon project ID (e.g., ‘dry-smoke-26258271’). Can be obtained from the project list or project details.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The Neon organization ID. Format: ‘org-xxxx-xxxx-xxxxxxxx’. Use the ‘get_user_organizations’ action to list available organization IDs. Note: VPC endpoints require Scale plan or higher.
string
required
The Neon AWS region ID where the VPC endpoint is located. Azure regions are not supported for VPC endpoints.
string
required
The AWS VPC endpoint ID. Format: ‘vpce-xxxxxxxxxxxxxxxxx’ (e.g., ‘vpce-1234567890abcdef0’). Use ‘get_vpc_region_endpoints’ action to list available VPC endpoints in a region.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEON_LIST_API_KEYSLists 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEON_LIST_AUTH_DOMAINSLists trusted redirect domains for the specified project and branch. An upstream 404 is returned as an empty domain list.

Input Parameters

string
required
The Neon branch ID
string
required
The Neon project ID. This is a string identifier in the format ‘adjective-noun-number’ (e.g., ‘proud-meadow-87189985’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEON_LIST_AUTH_OAUTH_PROVIDERSDeprecated 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.

Input Parameters

string
required
The Neon project ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique Neon project ID (e.g., ‘proud-meadow-87189985’). Can be found in the Neon console URL or via the list projects API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The Neon branch ID
string
required
The Neon project ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The branch ID
string
required
The Neon project ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique branch ID (e.g., ‘br-lucky-water-afkw1lov’). Can be obtained from the list branches API or Neon console.
string
required
The unique Neon project ID (e.g., ‘dry-smoke-26258271’). Can be found in the Neon console URL or via the list projects API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEON_LIST_ORGANIZATION_API_KEYSLists 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.

Input Parameters

string
required
The Neon organization ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The Neon organization ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Maximum number of members to return, from 1 to 500.
string
Opaque pagination cursor from response.pagination.next.
string
required
The Neon organization ID (e.g., ‘org-holy-recipe-01602027’). Can be obtained from the Get User Organizations endpoint.
string ("email" | "role" | "joined_at")
Field used to sort members: email, role, or joined_at.
string ("asc" | "desc")
Sort direction for this page. Reuse it with the cursor on subsequent requests.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEON_LIST_PROJECT_BRANCHESLists 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.

Input Parameters

string
Search by branch name or id. You can specify partial name or id values to filter results.
string
required
The Neon project ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEON_LIST_PROJECT_BRANCH_ROLESLists 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.

Input Parameters

string
required
The branch ID
string
required
The Neon project ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Specify the end 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.
string
required
Specify the start 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.
integer
Specify a value from 1 to 100 to limit number of projects in the response.
string
Specify the cursor value from the previous response to get the next batch of projects.
string
Organization whose project consumption metrics should be returned. Omit this field to return metrics for the authenticated user’s projects. Must contain 1-60 lowercase letters, digits, or hyphens.
string ("hourly" | "daily" | "monthly")
required
Specify the granularity of consumption metrics. Hourly, daily, and monthly metrics are available for the last 168 hours, 60 days, and 1 year, respectively.
array
Specify a list of project IDs to filter the response. If omitted, the response will contain all projects. A list of project IDs can be specified as an array of parameter values or as a comma-separated list in a single parameter value. - As an array of parameter values: 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-71788278
boolean
Include metrics utilized in previous pricing models. - data_storage_bytes_hour: The sum of the maximum observed storage values for each hour, which never decreases.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier for a Neon project (e.g., ‘calm-breeze-57229290’). Can be obtained from the projects list endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The Neon project ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Specify a value from 1 to 1000 to limit number of operations in the response
string
Specify the cursor value from the previous response to get the next batch of operations
string
required
The Neon project ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Project Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Specify a value from 1 to 400 to limit number of projects in the response.
string
Specify the cursor value from the previous response to retrieve the next batch of projects.
string
Organization ID to retrieve projects for. REQUIRED when using a Personal API key with an organization account (returns 400 error if omitted). NOT needed when using an Organization API key (key is already scoped). If you don’t have the org_id, call NEON_GET_USER_ORGANIZATIONS to discover it.
string
Search by project name or id. You can specify partial name or id values to filter results.
integer
Specify an explicit timeout in milliseconds to limit response delay. After timing out, the incomplete list of project data fetched so far will be returned. Projects still being fetched when the timeout occurred are listed in the “unavailable_project_ids” attribute of the response. Must be from 100 to 30000 milliseconds. If omitted, Neon chooses an implementation-defined timeout.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The Neon project ID (e.g., ‘proud-meadow-87189985’). You can obtain the project_id by listing projects for your Neon account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEON_LIST_PROJECT_VPC_ENDPOINTSLists the VPC endpoints associated with a Neon project. This read-only action returns existing private-network configurations and does not modify them.

Input Parameters

string
required
The Neon project ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEON_LIST_REGIONSLists active geographic regions available for Neon projects, including region identifiers, names, default status, and geographic coordinates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEON_LIST_SHARED_PROJECTSLists 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.

Input Parameters

integer
Maximum number of projects to return per page (1-400). Defaults to 10.
string
Pagination cursor from a previous response to retrieve the next page of results. Omit for the first request.
string
Filter projects by name or project ID. Case-insensitive partial match.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEON_LIST_USER_ORGANIZATIONSLists 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEON_LIST_VPC_ENDPOINTSLists VPC endpoints for a Neon organization across all regions, including each endpoint’s ID, label, and region.

Input Parameters

string
required
The Neon organization ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEON_LIST_VPC_REGION_ENDPOINTSLists 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.

Input Parameters

string
required
The Neon organization ID
string
required
The Neon region ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The branch ID where the role exists (e.g., ‘br-lucky-water-afkw1lov’)
string
required
The name of the database role whose password should be reset (e.g., ‘neondb_owner’, ‘authenticator’)
string
required
The Neon project ID (e.g., ‘dry-smoke-26258271’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The Neon project ID (e.g., ‘dry-smoke-26258271’). Can be obtained from list projects API.
string
required
The Neon compute endpoint ID to restart (e.g., ‘ep-patient-morning-afvkyj5f’). Can be obtained from list project endpoints API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The ID of the branch to restore (the target branch that will receive the restored data).
string
required
The Neon project ID containing the branch to restore.
string
A Log Sequence Number (LSN) on the source branch. The branch will be restored with data from this LSN. Format example: ‘0/19A3328’.
string
required
The branch_id of the restore source branch. If source_timestamp and source_lsn are omitted, the branch will be restored to head. If source_branch_id is equal to the branch’s id (self-restoration), source_timestamp or source_lsn is required.
string
A timestamp identifying a point in time on the source branch. The branch will be restored with data starting from this point in time. The timestamp must be provided in ISO 8601 format; for example: ‘2024-02-26T12:00:00Z’.
string
If provided, the previous state of the branch will be saved to a new branch with this name. Required if the branch has children or if source_branch_id equals the branch id (self-restoration). All existing child branches will be moved to the newly created branch under this name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
A name for the newly restored branch. If omitted, a default name will be generated.
string
required
The Neon project ID (e.g., ‘proud-meadow-87189985’). You can obtain the project_id by listing projects for your Neon account.
string
required
The snapshot ID to restore (e.g., ‘snap-wispy-union-ahw80v1u’). You can obtain snapshot IDs by listing snapshots for a project.
boolean
Set to true to finalize the restore operation immediately. This will complete the restore and move any associated computes to the new branch. Defaults to false to allow previewing the restored snapshot data first.
string
The ID of the branch to restore the snapshot into. If not specified, the branch from which the snapshot was originally created will be used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the branch within the project. Format: ‘br-adjective-noun-xxxxxxxx’ (e.g., ‘br-lucky-water-afkw1lov’). Obtain from list branches API.
string
required
The name of the database role whose password you want to reveal. Common roles include ‘neondb_owner’ (default owner), ‘authenticator’, ‘authenticated’, ‘anonymous’, or custom roles you’ve created.
string
required
The unique identifier of the Neon project. Format: ‘adjective-noun-12345678’ (e.g., ‘dry-smoke-26258271’). Obtain from list projects API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
SMTP server hostname (e.g., ‘smtp.gmail.com’, ‘smtp.sendgrid.net’).
integer
required
SMTP server port number. Common ports: 587 (TLS), 465 (SSL), 25 (unencrypted).
string
required
SMTP authentication password or app-specific password.
string
required
SMTP authentication username, typically an email address.
string
required
The Neon branch ID (e.g., ‘br-lucky-water-afkw1lov’). Obtain via NEON_GET_BRANCHES_FOR_PROJECT action.
string
required
The Neon project ID (e.g., ‘dry-smoke-26258271’). Obtain via NEON_RETRIEVE_PROJECTS_LIST action.
string
required
Display name that will appear as the sender of the test email.
string
required
Email address that will appear as the sender of the test email.
string
required
Email address where the test email will be sent.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The Neon organization ID
array
required
One or more invitations to create. Each item must contain the recipient’s email and assigned organization role.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The branch ID
string
required
The Neon project ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The branch ID
string
required
The Neon project ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique Neon project identifier (e.g., ‘dry-smoke-26258271’). Can be obtained from the projects list endpoint.
string
required
The unique compute endpoint identifier (e.g., ‘ep-patient-morning-afvkyj5f’). Can be obtained from the project endpoints list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEON_SUSPEND_PROJECT_ENDPOINT_BY_IDSuspends a specified Neon project’s compute endpoint, helping manage compute resource usage and costs. The response includes endpoint details and any initiated operations.

Input Parameters

string
required
The Neon project ID
string
required
The endpoint ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
required
The list of project IDs to transfer. Maximum of 400 project IDs per request. Each project ID must belong to the source organization and cannot have GitHub or Vercel integrations installed.
string
required
The Neon organization ID that currently owns the projects (source organization). This is the organization from which projects will be transferred.
string
required
The destination organization identifier to which the projects will be transferred. Must be a valid organization ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
required
List of project IDs to transfer from the user’s personal account to the organization. Maximum of 400 project IDs per request. Projects must be owned by the user and cannot have GitHub or Vercel integrations.
string
required
The unique identifier of the target organization to which the projects will be transferred. Must be an organization the user is a member of.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The Neon branch ID (e.g., ‘br-lucky-water-afkw1lov’). Can be obtained from the list branches API or Neon console.
string
required
The Neon project ID (e.g., ‘dry-smoke-26258271’). Can be found in the Neon console URL or via the list projects API.
boolean
required
Whether to allow localhost connections to this branch. Set to true to enable localhost access, false to disable.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
SMTP server hostname for custom email provider. Required if using a custom SMTP server instead of the shared provider (e.g., ‘smtp.gmail.com’, ‘smtp.sendgrid.net’). Leave empty to use the shared Neon email provider.
integer
SMTP server port. Required if using a custom SMTP server. Common ports: 587 (TLS), 465 (SSL), 25 (unencrypted). Leave empty to use the shared Neon email provider.
string
SMTP authentication password. Required if using a custom SMTP server. Leave empty to use the shared Neon email provider.
string
SMTP authentication username. Required if using a custom SMTP server. Leave empty to use the shared Neon email provider.
string
required
The Neon branch ID for which to update the email provider configuration. Format: ‘br-name-id’ (e.g., ‘br-lucky-water-afkw1lov’).
string
required
The Neon project ID. You can find this on the Settings page in the Neon Console or by listing projects. Format: ‘adjective-noun-12345678’ (e.g., ‘dry-smoke-26258271’).
string
required
The sender name to display in authentication emails. This appears as the ‘From’ name in email clients (e.g., ‘Composio Support’).
string
required
The sender email address to use for authentication emails sent from this branch. Must be a valid email format (e.g., ‘noreply@example.com’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
The OAuth application client ID. Required when updating provider credentials.
string
required
The Neon project ID (e.g., ‘dry-smoke-26258271’)
string
The OAuth application client secret. Required when updating provider credentials.
string ("google" | "github" | "microsoft" | "vercel")
required
The OAuth provider ID to update (google, github, microsoft, or vercel)
string
The Microsoft tenant ID. Only applicable when updating Microsoft OAuth provider.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
The new name for the database. Use this to rename the database.
string
required
The branch ID where the database resides (e.g., ‘br-lucky-water-afkw1lov’)
string
required
The Neon project ID (e.g., ‘dry-smoke-26258271’)
string
required
The current name of the database to update
string
The name of the role to transfer database ownership to. The role must exist in the branch.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The Neon branch ID (e.g., ‘br-gentle-lab-af8riisw’)
array
List of schemas to expose via the API. Default: [“public”]
string
required
The Neon project ID (e.g., ‘small-recipe-63664710’)
integer
Maximum number of rows that can be returned in a single request
string
Database role to use for anonymous requests. Default: ‘anonymous’
string ("ignore-privileges" | "disabled")
OpenAPI specification mode (ignore-privileges, disabled). Default: ‘disabled’
string
required
The database name (e.g., ‘neondb’)
string
JWT claim key to use for role extraction. Default: ”.“role""
string
Extra schemas to add to the search path
boolean
Enable aggregates feature. Default: true
boolean
Enable server timing headers
integer
Maximum lifetime for JWT cache in seconds
string
CORS allowed origins

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The branch ID. You can obtain this by listing the project’s branches. The branch must be an anonymized branch.
string
required
The Neon project ID. You can obtain this by listing the projects for your Neon account.
array
required
List of masking rules to apply to the branch. This will replace all existing masking rules for the branch. Pass an empty array to remove all masking rules.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEON_UPDATE_ORGANIZATION_MEMBER_ROLEChanges an organization member’s role between admin and member, updating their ability to manage organization resources and members.

Input Parameters

string ("admin" | "member")
required
The role of the organization member
string
required
The Neon organization ID
string
required
The Neon organization member ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
The new name for the branch. If not provided, the branch name remains unchanged. Branch names should be descriptive and follow your team’s naming conventions (e.g., ‘main’, ‘production’, ‘development’, ‘feature-xyz’).
string
required
The unique identifier of the branch to modify. Format: ‘br-<adjective>-<noun>-<alphanumeric>’ (e.g., ‘br-square-base-aehfbgdy’). Can be obtained from the branches list endpoint for a project.
boolean
Whether the branch should be protected. Protected branches have restrictions that prevent certain destructive operations. Set to true to enable protection, false to disable it. If not provided, the protection status remains unchanged. Note: Protection features may require a paid plan.
string
required
The unique identifier of the Neon project containing the branch to modify. Format: ‘<adjective>-<noun>-<number>’ (e.g., ‘calm-breeze-57229290’). Can be obtained from the projects list endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

boolean
Whether to restrict connections to the compute endpoint. Enabling this option schedules a suspend compute operation. A disabled compute endpoint cannot be enabled by a connection or console action. However, the compute endpoint is periodically enabled by check_availability operations.
string
DEPRECATED: This field will be removed in a future release. The destination branch ID. The destination branch must not have an exsiting read-write endpoint.
string
required
The Neon project ID
string
required
The endpoint ID
object
A raw representation of Postgres settings
string ("transaction")
The connection pooler mode. Neon supports PgBouncer in transaction mode only.
string ("k8s-pod" | "k8s-neonvm" | "docker" | "serverless-platform")
Compute provisioner. k8s-neonvm supports autoscaling; k8s-pod is fixed-size. Neon also accepts docker and serverless-platform.
boolean
Whether to enable connection pooling for the compute endpoint
object
A raw representation of PgBouncer settings
boolean
NOT YET IMPLEMENTED by Neon. Retained for backward compatibility; setting this field may have no effect.
integer
Duration of inactivity in seconds after which the compute endpoint is automatically suspended. The value 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.
number
Maximum autoscaling compute units. Must be at least 0.25.
number
Minimum autoscaling compute units. Must be at least 0.25.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
The project name
string
required
The Neon project ID
array
A list of IP addresses that are allowed to connect to the endpoint.
boolean
When set, connections using VPC endpoints are disallowed. This parameter is under active development and its semantics may change in the future.
boolean
When set, connections from the public internet are disallowed. This supersedes the AllowedIPs list. This parameter is under active development and its semantics may change in the future.
integer
Limit on the logical size of every project”s branch.
integer
Total amount of data written to all of a project”s branches.
integer
The number of seconds to retain the shared history for all branches in this project. The default is 1 day (604800 seconds).
integer
The total amount of wall-clock time allowed to be spent by the project”s compute endpoints.
integer
Total amount of data transferred from all of a project”s branches using the proxy.
boolean
Sets wal_level=logical for all compute endpoints in this project. All active endpoints will be suspended. Once enabled, logical replication cannot be disabled.
integer
The total amount of CPU seconds allowed to be spent by the project”s compute endpoints.
string
End time of the maintenance window, in the format of “HH:MM”. Uses UTC.
array
A list of weekdays when the maintenance window is active. Encoded as ints, where 1 - Monday, and 7 - Sunday.
object
A raw representation of Postgres settings
string
Start time of the maintenance window, in the format of “HH:MM”. Uses UTC.
boolean
If true, the list will be applied only to protected branches.
object
A raw representation of PgBouncer settings
integer
Duration of inactivity in seconds after which the compute endpoint is automatically suspended. The value 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.
number
Default maximum autoscaling compute units. Must be at least 0.25.
number
Default minimum autoscaling compute units. Must be at least 0.25.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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.

Input Parameters

string
required
The new name for the snapshot. Use a descriptive name to identify the snapshot’s purpose or content.
string
required
The Neon project ID (e.g., ‘proud-meadow-87189985’). Obtain via NEON_RETRIEVE_PROJECTS_LIST action.
string
required
The snapshot ID to update (e.g., ‘snap-wispy-union-ahw80v1u’). Must match pattern ^[a-z0-9-]{1,60}$.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not