data
Neon MCP, CLI, and Lua Integration for AI Agents
Neon integration docs for AI agents: MCP gateway setup, Neon CLI commands, Lua API reference, credentials, and function schemas.Neon for agents
Credentials can be configured manually in web or CLI hosts.
Use this integration from Lua code mode, the headless integrations CLI, or the KosmoKrator MCP gateway. The same package metadata powers all three surfaces.
Agent Surfaces
Machine-Readable Metadata
Function Catalog
| Function | Type | Parameters | Description |
|---|---|---|---|
neon.neon_get_project_advisor_security_issues | Read read | 0 | Analyzes the database for security and performance issues. Returns a list of issues categorized by severity ERROR, WARN, INFO. Requires read access to the project and Data API enabled. |
neon.neon_list_api_keys | Read read | 0 | Retrieves the API keys for your Neon account. The response does not include API key tokens. A token is only provided when creating an API key. API keys can also be managed in the Neon Console. For more information, see Manage API keyshttps://neon.tech/docs/manage/api-keys/. |
neon.neon_create_api_key | Write write | 0 | Creates an API key. The keyname is a user-specified name for the key. This method returns an id and key. The key is a randomly generated, 64-bit token required to access the Neon API. API keys can also be managed in the Neon Console. See Manage API keyshttps://neon.tech/docs/manage/api-keys/. |
neon.neon_revoke_api_key | Write write | 0 | Revokes the specified API key. An API key that is no longer needed can be revoked. This action cannot be reversed. You can obtain keyid values by listing the API keys for your Neon account. API keys can also be managed in the Neon Console. See Manage API keyshttps://neon.tech/docs/manage/api-keys/. |
neon.neon_get_project_operation | Read read | 0 | Retrieves details for the specified operation. An operation is an action performed on a Neon project resource. You can obtain a projectid by listing the projects for your Neon account. You can obtain a operationid by listing operations for the project. |
neon.neon_list_projects | Read read | 0 | Retrieves a list of projects for an organization. You may need to specify an orgid parameter depending on your API key type. For more information, see Manage projectshttps://neon.tech/docs/manage/projects/. |
neon.neon_create_project | Write write | 0 | Creates a Neon project within an organization. You may need to specify an orgid parameter depending on your API key type. Plan limits define how many projects you can create. For more information, see Manage projectshttps://neon.tech/docs/manage/projects/. You can specify a region and Postgres version in the request body. Neon currently supports PostgreSQL 14, 15, 16, and 17. For supported regions and regionid values, see Regionshttps://neon.tech/docs/introduction/regions/. |
neon.neon_list_shared_projects | Read read | 0 | Retrieves a list of projects shared with your Neon account. For more information, see Manage projectshttps://neon.tech/docs/manage/projects/. |
neon.neon_get_project | Read read | 0 | Retrieves information about the specified project. You can obtain a projectid by listing the projects for an organization. |
neon.neon_update_project | Write write | 0 | Updates the specified project. You can obtain a projectid by listing the projects for your Neon account. |
neon.neon_delete_project | Write write | 0 | Deletes the specified project. You can obtain a projectid by listing the projects for your Neon account. Deleting a project is a permanent action. Deleting a project also deletes endpoints, branches, databases, and users that belong to the project. |
neon.neon_recover_project | Write write | 0 | Recovers a deleted project during the deletion grace period. You can obtain a projectid by listing the projects for your Neon account. |
neon.neon_list_project_operations | Read read | 0 | Retrieves a list of operations for the specified Neon project. You can obtain a projectid by listing the projects for your Neon account. The number of operations returned can be large. To paginate the response, issue an initial request with a limit value. Then, add the cursor value that was returned in the response to the next request. Operations older than 6 months may be deleted from our systems. If you need more history than that, you should store your own history. |
neon.neon_list_project_permissions | Read read | 0 | Retrieves details about users who have access to the project, including the permission id, the granted-to email address, and the date project access was granted. |
neon.neon_grant_permission_to_project | Write write | 0 | Grants project access to the account associated with the specified email address |
neon.neon_revoke_permission_from_project | Write write | 0 | Revokes project access from the user associated with the specified permission id. You can retrieve a user's permission id by listing project access. |
neon.neon_get_available_preload_libraries | Read read | 0 | Return available shared preload libraries |
neon.neon_create_project_transfer_request | Write write | 0 | Creates a transfer request for the specified project. A transfer request allows the project to be transferred to another account or organization. The request has an expiration time after which it can no longer be used. To accept/claim the transfer request, the recipient user/organization must call the /projects/{projectid}/transferrequests/{requestid} API endpoint, or visit https://console.neon.tech/app/claim?p={projectid}&tr={requestid}&ru={redirecturl} in the Neon Console. The ru parameter is optional and can be used to redirect the user after accepting the transfer request. |
neon.neon_accept_project_transfer_request | Write write | 0 | Accepts a transfer request for the specified project, transferring it to the specified organization or user. If orgid is not passed, the project will be transferred to the current user or organization account. |
neon.neon_get_project_j_w_k_s | Read read | 0 | Returns the JWKS URLs available for verifying JWTs used as the authentication mechanism for the specified project. |
neon.neon_add_project_j_w_k_s | Write write | 0 | Add a new JWKS URL to a project, such that it can be used for verifying JWTs used as the authentication mechanism for the specified project. The URL must be a valid HTTPS URL that returns a JSON Web Key Set. The providername field allows you to specify which authentication provider you're using e.g., Clerk, Auth0, AWS Cognito, etc.. The branchid can be used to specify on which branches the JWKS URL will be accepted. If not specified, then it will work on any branch. The rolenames can be used to specify for which roles the JWKS URL will be accepted. If not specified, then default roles will be used authenticator, authenticated and anonymous. The jwtaudience can be used to specify which "aud" values should be accepted by Neon in the JWTs that are used for authentication. |
neon.neon_delete_project_j_w_k_s | Write write | 0 | Deletes a JWKS URL from the specified project |
neon.neon_create_project_branch_data_a_p_i | Write write | 0 | Creates a new instance of Neon Data API in the specified branch. You can obtain the projectid and branchid by listing the projects and branches for your Neon account. |
neon.neon_update_project_branch_data_a_p_i | Write write | 0 | Updates the Neon Data API configuration for the specified branch. You can optionally provide settings to update the Data API configuration. The schema cache is always refreshed as part of this operation. You can obtain the projectid and branchid by listing the projects and branches for your Neon account. |
neon.neon_delete_project_branch_data_a_p_i | Write write | 0 | Deletes the Neon Data API for the specified branch. You can obtain the projectid and branchid by listing the projects and branches for your Neon account. |
neon.neon_get_project_branch_data_a_p_i | Read read | 0 | Retrieves the Neon Data API for the specified branch. |
neon.neon_create_neon_auth_integration | Write write | 0 | DEPRECATED, use /projects/{projectid}/branches/{branchid}/auth instead. Creates a project on a third-party authentication provider's platform for use with Neon Auth. Use this endpoint if the frontend integration flow can't be used. |
neon.neon_get_neon_auth | Read read | 0 | / Fetches the details of the Neon Auth for the specified branch. You can obtain the projectid and branchid by listing the projects and branches for your Neon account. |
neon.neon_create_neon_auth | Write write | 0 | Enables Neon Auth integrationfor the branch. You can obtain the projectid and branchid by listing the projects and branches for your Neon account. |
neon.neon_disable_neon_auth | Write write | 0 | Disables Neon Auth for the branch |
neon.neon_list_neon_auth_redirect_u_r_i_whitelist_domains | Read read | 0 | DEPRECATED, use /projects/{projectid}/branches/{branchid}/auth/domains instead. Lists the domains in the redirecturi whitelist for the specified project. |
neon.neon_add_neon_auth_domain_to_redirect_u_r_i_whitelist | Write write | 0 | DEPRECATED, use /projects/{projectid}/branches/{branchid}/auth/domains instead. Adds a domain to the redirecturi whitelist for the specified project. |
neon.neon_delete_neon_auth_domain_from_redirect_u_r_i_whitelist | Write write | 0 | DEPRECATED, use /projects/{projectid}/branches/{branchid}/auth/domains instead. Deletes a domain from the redirecturi whitelist for the specified project. |
neon.neon_list_branch_neon_auth_trusted_domains | Read read | 0 | Lists the domains in the redirecturi whitelist for the specified project. |
neon.neon_add_branch_neon_auth_trusted_domain | Write write | 0 | Adds a domain to the redirecturi whitelist for the specified project. |
neon.neon_delete_branch_neon_auth_trusted_domain | Write write | 0 | Deletes a domain from the redirecturi whitelist for the specified project. |
neon.neon_create_neon_auth_provider_s_d_k_keys | Write write | 0 | Generates SDK or API Keys for the auth provider. These might be called different things depending on the auth provider you're using, but are generally used for setting up the frontend and backend SDKs. |
neon.neon_create_neon_auth_new_user | Write write | 0 | DEPRECATED, use /projects/{projectid}/branches/{branchid}/auth/users instead. Creates a new user in Neon Auth. The user will be created in your neonauth.userssync table and automatically propagated to your auth project, whether Neon-managed or provider-owned. |
neon.neon_create_branch_neon_auth_new_user | Write write | 0 | Creates a new user in Neon Auth. |
neon.neon_delete_branch_neon_auth_user | Write write | 0 | Deletes the auth user for the specified project. |
neon.neon_update_neon_auth_user_role | Write write | 0 | Updates the role of an auth user for the specified project. |
neon.neon_delete_neon_auth_user | Write write | 0 | DEPRECATED, use /projects/{projectid}/branches/{branchid}/auth/users/{authuserid} instead. Deletes the auth user for the specified project. |
neon.neon_transfer_neon_auth_provider_project | Write write | 0 | Transfer ownership of your Neon-managed auth project to your own auth provider account. |
neon.neon_list_neon_auth_integrations | Read read | 0 | DEPRECATED, use /projects/{projectid}/branches/{branchid}/auth instead. |
neon.neon_list_neon_auth_oauth_providers | Read read | 0 | DEPRECATED, use /projects/{projectid}/branches/{branchid}/auth/oauthproviders instead. Lists the OAuth providers for the specified project. |
neon.neon_add_neon_auth_oauth_provider | Write write | 0 | DEPRECATED, use /projects/{projectid}/branches/{branchid}/auth/oauthproviders instead. Adds a OAuth provider to the specified project. |
neon.neon_list_branch_neon_auth_oauth_providers | Read read | 0 | Lists the OAuth providers for the specified project and branch. |
neon.neon_add_branch_neon_auth_oauth_provider | Write write | 0 | Adds a OAuth provider to the specified project. |
neon.neon_update_neon_auth_oauth_provider | Write write | 0 | DEPRECATED, use /projects/{projectid}/branches/{branchid}/auth/oauthproviders/{oauthproviderid} instead. Updates a OAuth provider for the specified project. |
neon.neon_delete_neon_auth_oauth_provider | Write write | 0 | DEPRECATED, use /projects/{projectid}/branches/{branchid}/auth/oauthproviders/{oauthproviderid} instead. Deletes a OAuth provider from the specified project. |
neon.neon_update_branch_neon_auth_oauth_provider | Write write | 0 | Updates a OAuth provider for the specified project. |
neon.neon_delete_branch_neon_auth_oauth_provider | Write write | 0 | Deletes a OAuth provider from the specified project. |
neon.neon_get_neon_auth_email_server | Read read | 0 | DEPRECATED, use /projects/{projectid}/branches/{branchid}/auth/emailprovider instead. Gets the email server configuration for the specified project. |
neon.neon_update_neon_auth_email_server | Write write | 0 | DEPRECATED, use /projects/{projectid}/branches/{branchid}/auth/emailprovider instead. Updates the email server configuration for the specified project. |
neon.neon_send_neon_auth_test_email | Write write | 0 | Sends a test email to the specified email address. |
neon.neon_get_neon_auth_email_and_password_config | Read read | 0 | Gets the email and password authentication configuration for Neon Auth |
neon.neon_update_neon_auth_email_and_password_config | Write write | 0 | Updates the email and password authentication configuration for Neon Auth |
neon.neon_get_neon_auth_email_provider | Read read | 0 | Gets the email provider configuration for the specified branch. |
neon.neon_update_neon_auth_email_provider | Write write | 0 | Updates the email provider configuration for the specified branch. |
neon.neon_delete_neon_auth_integration | Write write | 0 | DEPRECATED, use /projects/{projectid}/branches/{branchid}/auth instead. |
neon.neon_get_connection_u_r_i | Read read | 0 | Retrieves a connection URI for the specified database. You can obtain a projectid by listing the projects for your Neon account. You can obtain the databasename by listing the databases for a branch. You can obtain a rolename by listing the roles for a branch. |
neon.neon_get_neon_auth_allow_localhost | Read read | 0 | Get the allow localhost configuration for the specified branch. |
neon.neon_update_neon_auth_allow_localhost | Write write | 0 | Updates the allow localhost configuration for the specified branch. |
neon.neon_get_neon_auth_plugin_configs | Read read | 0 | Returns all plugin configurations for Neon Auth in a single response. This endpoint aggregates organization, email provider, email and password, OAuth providers, and localhost settings. |
neon.neon_update_neon_auth_organization_plugin | Write write | 0 | Updates the organization plugin configuration for Neon Auth. The organization plugin enables multi-tenant organization support. |
neon.neon_update_neon_auth_config | Write write | 0 | Updates the auth configuration for the branch. Currently supports updating the application name used in auth emails. |
neon.neon_update_neon_auth_magic_link_plugin | Write write | 0 | Updates the magic link plugin configuration for Neon Auth. The magic link plugin enables passwordless authentication via email magic links. |
neon.neon_get_neon_auth_phone_number_plugin | Read read | 0 | Returns the phone number plugin configuration for Neon Auth. The phone number plugin enables phone-based OTP authentication. |
neon.neon_update_neon_auth_phone_number_plugin | Write write | 0 | Updates the phone number plugin configuration for Neon Auth. Only the fields provided in the request body are updated; omitted fields retain their current values. The phone number plugin enables phone-based OTP authentication. OTP codes are delivered via the send.otp webhook event with deliverypreference: "sms". A webhook must be configured with the send.otp event enabled for SMS delivery to work. |
neon.neon_get_neon_auth_webhook_config | Read read | 0 | Returns the webhook configuration for Neon Auth. |
neon.neon_update_neon_auth_webhook_config | Write write | 0 | Updates the webhook configuration for Neon Auth on a specific branch. |
neon.neon_create_project_branch | Write write | 0 | Creates a branch in the specified project. You can obtain a projectid by listing the projects for your Neon account. This method does not require a request body, but you can specify one to create a compute endpoint for the branch or to select a non-default parent branch. By default, the branch is created from the project's default branch with no compute endpoint, and the branch name is auto-generated. To access the branch, you must add an endpoint object. A readwrite endpoint allows you to perform read and write operations on the branch. Each branch supports one read-write endpoint and multiple read-only endpoints. For related information, see Manage brancheshttps://neon.tech/docs/manage/branches/. |
neon.neon_list_branches | Read read | 0 | Retrieves a list of branches for the specified project. You can obtain a projectid by listing the projects for your Neon account. Each Neon project has a root branch named main. A branchid value has a br- prefix. A project may contain child branches that were branched from main or from another branch. A parent branch is identified by the parentid value, which is the id of the parent branch. For related information, see Manage brancheshttps://neon.tech/docs/manage/branches/. |
neon.neon_create_project_branch_anonymized | Write write | 0 | Creates a new branch with anonymized data using PostgreSQL Anonymizer for static masking. This allows developers to work with masked production data. Optionally, provide maskingrules to set initial masking rules for the branch and startanonymization to automatically start anonymization after creation. This combines functionality of updating masking rules and starting anonymization into the branch creation request. Note: This endpoint is currently in Beta. |
neon.neon_count_project_branches | Read read | 0 | Retrieves the total number of branches in the specified project. You can obtain a projectid by listing the projects for your Neon account. |
neon.neon_get_branch | Read read | 0 | Retrieves information about the specified branch. You can obtain a projectid by listing the projects for your Neon account. You can obtain a branchid by listing the project's branches. A branchid value has a br- prefix. Each Neon project is initially created with a root and default branch named main. A project can contain one or more branches. A parent branch is identified by a parentid value, which is the id of the parent branch. For related information, see Manage brancheshttps://neon.tech/docs/manage/branches/. |
neon.neon_delete_project_branch | Write write | 0 | Deletes the specified branch from a project, and places all compute endpoints into an idle state, breaking existing client connections. You can obtain a projectid by listing the projects for your Neon account. You can obtain a branchid by listing the project's branches. For related information, see Manage brancheshttps://neon.tech/docs/manage/branches/. When a successful response status is received, the compute endpoints are still active, and the branch is not yet deleted from storage. The deletion occurs after all operations finish. You cannot delete a project's root or default branch, and you cannot delete a branch that has a child branch. A project must have at least one branch. By default, deleted branches can be recovered within a 7-day grace period. Use the harddelete parameter to permanently delete the branch immediately without a recovery window. Soft delete and branch recovery are in preview and not available to all users. |
neon.neon_update_project_branch | Write write | 0 | Updates the specified branch. You can obtain a projectid by listing the projects for your Neon account. You can obtain the branchid by listing the project's branches. For more information, see Manage brancheshttps://neon.tech/docs/manage/branches/. |
neon.neon_restore_project_branch | Write write | 0 | Restores a branch to an earlier state in its own or another branch's history |
neon.neon_get_project_branch_schema | Read read | 0 | Retrieves the schema from the specified database. The lsn and timestamp values cannot be specified at the same time. If both are omitted, the database schema is retrieved from database's head. |
neon.neon_get_project_branch_schema_comparison | Read read | 0 | Compares the schema from the specified database with another branch's schema. |
neon.neon_get_masking_rules | Read read | 0 | Retrieves the masking rules for the specified anonymized branch. Masking rules define how sensitive data should be anonymized using PostgreSQL Anonymizer. You can obtain a projectid by listing the projects for your Neon account. You can obtain the branchid by listing the project's branches. Note: This endpoint is currently in Beta. |
neon.neon_update_masking_rules | Write write | 0 | Updates the masking rules for the specified anonymized branch. Masking rules define how sensitive data should be anonymized using PostgreSQL Anonymizer. You can obtain a projectid by listing the projects for your Neon account. You can obtain the branchid by listing the project's branches. Note: This endpoint is currently in Beta. |
neon.neon_get_anonymized_branch_status | Read read | 0 | Retrieves the current status of an anonymized branch, including its state and progress information. This endpoint allows you to monitor the anonymization process from initialization through completion. You can obtain a projectid by listing the projects for your Neon account. You can obtain the branchid by listing the project's branches. Only anonymized branches will have status information available. Note: This endpoint is currently in Beta. |
neon.neon_start_anonymization | Write write | 0 | Starts the anonymization process for an anonymized branch that is in the initialized, error, or anonymized state. This will apply all defined masking rules to anonymize sensitive data in the branch databases. You can obtain a projectid by listing the projects for your Neon account. You can obtain the branchid by listing the project's branches. The branch must be an anonymized branch to start anonymization. Note: This endpoint is currently in Beta. |
neon.neon_set_default_project_branch | Write write | 0 | Sets the specified branch as the project's default branch. The default designation is automatically removed from the previous default branch. You can obtain a projectid by listing the projects for your Neon account. You can obtain the branchid by listing the project's branches. For more information, see Manage brancheshttps://neon.tech/docs/manage/branches/. |
neon.neon_recover_project_branch | Write write | 0 | Recovers a deleted branch during the deletion grace period 7 days. The branch must have been soft deleted and not yet permanently deleted. Recovery restores the branch and its endpoints to an idle state. Connection strings remain valid after recovery. TTL branches become non-TTL branches after recovery. This endpoint is in preview and not available to all users. |
neon.neon_finalize_restore_branch | Write write | 0 | Finalize the restore operation for a branch created from a snapshot. This operation updates the branch so it functions as the original branch it replaced. This includes: - Reassigning any computes from the original branch to the restored branch this will restart the computes - Renaming the restored branch to the original branch's name - Renaming the original branch so it no longer uses the original name This operation only applies to branches created using the restoreSnapshot endpoint with finalizerestore: false. Note: This endpoint is currently in Beta. |
neon.neon_list_project_branch_endpoints | Read read | 0 | Retrieves a list of compute endpoints for the specified branch. Neon permits only one read-write compute endpoint per branch. A branch can have multiple read-only compute endpoints. You can obtain a projectid by listing the projects for your Neon account. You can obtain the branchid by listing the project's branches. |
neon.neon_list_databases | Read read | 0 | Retrieves a list of databases for the specified branch. A branch can have multiple databases. You can obtain a projectid by listing the projects for your Neon account. You can obtain the branchid by listing the project's branches. For related information, see Manage databaseshttps://neon.tech/docs/manage/databases/. |
neon.neon_create_project_branch_database | Write write | 0 | Creates a database in the specified branch. A branch can have multiple databases. You can obtain a projectid by listing the projects for your Neon account. You can obtain the branchid by listing the project's branches. For related information, see Manage databaseshttps://neon.tech/docs/manage/databases/. |
neon.neon_get_project_branch_database | Read read | 0 | Retrieves information about the specified database. You can obtain a projectid by listing the projects for your Neon account. You can obtain the branchid and databasename by listing the branch's databases. For related information, see Manage databaseshttps://neon.tech/docs/manage/databases/. |
neon.neon_update_project_branch_database | Write write | 0 | Updates the specified database in the branch. You can obtain a projectid by listing the projects for your Neon account. You can obtain the branchid and databasename by listing the branch's databases. For related information, see Manage databaseshttps://neon.tech/docs/manage/databases/. |
neon.neon_delete_project_branch_database | Write write | 0 | Deletes the specified database from the branch. You can obtain a projectid by listing the projects for your Neon account. You can obtain the branchid and databasename by listing the branch's databases. For related information, see Manage databaseshttps://neon.tech/docs/manage/databases/. |
neon.neon_list_project_branch_roles | Read read | 0 | Retrieves a list of Postgres roles from the specified branch. You can obtain a projectid by listing the projects for your Neon account. You can obtain the branchid by listing the project's branches. For related information, see Manage roleshttps://neon.tech/docs/manage/roles/. |
neon.neon_create_project_branch_role | Write write | 0 | Creates a Postgres role in the specified branch. You can obtain a projectid by listing the projects for your Neon account. You can obtain the branchid by listing the project's branches. For related information, see Manage roleshttps://neon.tech/docs/manage/roles/. Connections established to the active compute endpoint will be dropped. If the compute endpoint is idle, the endpoint becomes active for a short period of time and is suspended afterward. |
neon.neon_get_project_branch_role | Read read | 0 | Retrieves details about the specified role. You can obtain a projectid by listing the projects for your Neon account. You can obtain the branchid by listing the project's branches. You can obtain the rolename by listing the roles for a branch. In Neon, the terms "role" and "user" are synonymous. For related information, see Manage roleshttps://neon.tech/docs/manage/roles/. |
neon.neon_delete_project_branch_role | Write write | 0 | Deletes the specified Postgres role from the branch. You can obtain a projectid by listing the projects for your Neon account. You can obtain the branchid by listing the project's branches. You can obtain the rolename by listing the roles for a branch. For related information, see Manage roleshttps://neon.tech/docs/manage/roles/. |
neon.neon_get_project_branch_role_password | Read read | 0 | Retrieves the password for the specified Postgres role, if possible. You can obtain a projectid by listing the projects for your Neon account. You can obtain the branchid by listing the project's branches. You can obtain the rolename by listing the roles for a branch. For related information, see Manage roleshttps://neon.tech/docs/manage/roles/. |
neon.neon_reset_project_branch_role_password | Write write | 0 | Resets the password for the specified Postgres role. Returns a new password and operations. The new password is ready to use when the last operation finishes. The old password remains valid until last operation finishes. Connections to the compute endpoint are dropped. If idle, the compute endpoint becomes active for a short period of time. You can obtain a projectid by listing the projects for your Neon account. You can obtain the branchid by listing the project's branches. You can obtain the rolename by listing the roles for a branch. For related information, see Manage roleshttps://neon.tech/docs/manage/roles/. |
neon.neon_list_project_v_p_c_endpoints | Read read | 0 | Lists VPC endpoint restrictions for the specified Neon project. |
neon.neon_assign_project_v_p_c_endpoint | Write write | 0 | Sets or updates a VPC endpoint restriction for a Neon project. When a VPC endpoint restriction is set, the project only accepts connections from the specified VPC. A VPC endpoint can be set as a restriction only after it is assigned to the parent organization of the Neon project. |
neon.neon_delete_project_v_p_c_endpoint | Write write | 0 | Removes the specified VPC endpoint restriction from a Neon project. |
neon.neon_create_project_endpoint | Write write | 0 | Creates a compute endpoint for the specified branch. An endpoint is a Neon compute instance. There is a maximum of one read-write compute endpoint per branch. If the specified branch already has a read-write compute endpoint, the operation fails. A branch can have multiple read-only compute endpoints. You can obtain a projectid by listing the projects for your Neon account. You can obtain branchid by listing the project's branches. A branchid has a br- prefix. For supported regions and regionid values, see Regionshttps://neon.tech/docs/introduction/regions/. For more information about compute endpoints, see Manage computeshttps://neon.tech/docs/manage/endpoints/. |
neon.neon_list_project_endpoints | Read read | 0 | Retrieves a list of compute endpoints for the specified project. A compute endpoint is a Neon compute instance. You can obtain a projectid by listing the projects for your Neon account. For information about compute endpoints, see Manage computeshttps://neon.tech/docs/manage/endpoints/. |
neon.neon_get_project_endpoint | Read read | 0 | Retrieves information about the specified compute endpoint. A compute endpoint is a Neon compute instance. You can obtain a projectid by listing the projects for your Neon account. You can obtain an endpointid by listing your project's compute endpoints. An endpointid has an ep- prefix. For information about compute endpoints, see Manage computeshttps://neon.tech/docs/manage/endpoints/. |
neon.neon_delete_project_endpoint | Write write | 0 | Delete the specified compute endpoint. A compute endpoint is a Neon compute instance. Deleting a compute endpoint drops existing network connections to the compute endpoint. The deletion is completed when last operation in the chain finishes successfully. You can obtain a projectid by listing the projects for your Neon account. You can obtain an endpointid by listing your project's compute endpoints. An endpointid has an ep- prefix. For information about compute endpoints, see Manage computeshttps://neon.tech/docs/manage/endpoints/. |
neon.neon_update_project_endpoint | Write write | 0 | Updates the specified compute endpoint. You can obtain a projectid by listing the projects for your Neon account. You can obtain an endpointid and branchid by listing your project's compute endpoints. An endpointid has an ep- prefix. A branchid has a br- prefix. For more information about compute endpoints, see Manage computeshttps://neon.tech/docs/manage/endpoints/. If the returned list of operations is not empty, the compute endpoint is not ready to use. The client must wait for the last operation to finish before using the compute endpoint. If the compute endpoint was idle before the update, it becomes active for a short period of time, and the control plane suspends it again after the update. |
neon.neon_start_project_endpoint | Write write | 0 | Starts a compute endpoint. The compute endpoint is ready to use after the last operation in chain finishes successfully. You can obtain a projectid by listing the projects for your Neon account. You can obtain an endpointid by listing your project's compute endpoints. An endpointid has an ep- prefix. For information about compute endpoints, see Manage computeshttps://neon.tech/docs/manage/endpoints/. |
neon.neon_suspend_project_endpoint | Write write | 0 | Suspend the specified compute endpoint You can obtain a projectid by listing the projects for your Neon account. You can obtain an endpointid by listing your project's compute endpoints. An endpointid has an ep- prefix. For information about compute endpoints, see Manage computeshttps://neon.tech/docs/manage/endpoints/. |
neon.neon_restart_project_endpoint | Write write | 0 | Restart the specified compute endpoint: suspend immediately followed by start operations. You can obtain a projectid by listing the projects for your Neon account. You can obtain an endpointid by listing your project's compute endpoints. An endpointid has an ep- prefix. For information about compute endpoints, see Manage computeshttps://neon.tech/docs/manage/endpoints/. |
neon.neon_get_consumption_history_per_account | Read read | 0 | Retrieves consumption metrics for Scale and Enterprise plan accounts, and for legacy Scale, Business, and Enterprise plan accounts. Consumption history begins at the time the account was upgraded to a supported plan. Deprecated: This endpoint will be removed on June 1, 2026. |
neon.neon_get_consumption_history_per_project | Read read | 0 | Retrieves consumption metrics for Scale, Business, and Enterprise plan projects. History begins at the time of upgrade. Results are ordered by time in ascending order oldest to newest. Issuing a call to this API does not wake a project's compute endpoint. |
neon.neon_get_consumption_history_per_project_v2 | Read read | 0 | Retrieves consumption metrics for Launch, Scale, Agent, and Enterprise plan projects. History begins at the time of upgrade. Results are ordered by time in ascending order oldest to newest. Issuing a call to this API does not wake a project's compute endpoint. |
neon.neon_get_organization | Read read | 0 | Retrieves information about the specified organization. |
neon.neon_list_org_api_keys | Read read | 0 | Retrieves the API keys for the specified organization. The response does not include API key tokens. A token is only provided when creating an API key. API keys can also be managed in the Neon Console. For more information, see Manage API keyshttps://neon.tech/docs/manage/api-keys/. |
neon.neon_create_org_api_key | Write write | 0 | Creates an API key for the specified organization. The keyname is a user-specified name for the key. This method returns an id and key. The key is a randomly generated, 64-bit token required to access the Neon API. API keys can also be managed in the Neon Console. See Manage API keyshttps://neon.tech/docs/manage/api-keys/. |
neon.neon_revoke_org_api_key | Write write | 0 | Revokes the specified organization API key. An API key that is no longer needed can be revoked. This action cannot be reversed. You can obtain keyid values by listing the API keys for an organization. API keys can also be managed in the Neon Console. See Manage API keyshttps://neon.tech/docs/manage/api-keys/. |
neon.neon_get_organization_spending_limit | Read read | 0 | Returns the configured spending limit for a V3 paid organization. spendinglimitcents: null indicates that no limit is currently set. Available to organization members with read access on Launch and Scale plans only. |
neon.neon_set_organization_spending_limit | Write write | 0 | Sets the spending limit for a V3 paid organization. To remove a previously configured limit, send a DELETE request to this endpoint. When a limit is configured, email notifications are sent at 80% and 100% of the limit. Computes are not suspended by this feature. Available to organization admins on Launch and Scale plans only. |
neon.neon_delete_organization_spending_limit | Write write | 0 | Removes a previously configured spending limit for a V3 paid organization. Idempotent deleting an already-unset limit still succeeds. Available to organization admins on Launch and Scale plans only. |
neon.neon_get_organization_members | Read read | 0 | Retrieves a paginated list of members for the specified organization. |
neon.neon_get_organization_member | Read read | 0 | Retrieves information about the specified organization member. |
neon.neon_update_organization_member | Write write | 0 | Only an admin can perform this action. |
neon.neon_remove_organization_member | Write write | 0 | Remove member from the organization. Only an admin of the organization can perform this action. If another admin is being removed, it will not be allows in case it is the only admin left in the organization. |
neon.neon_get_organization_invitations | Read read | 0 | Retrieves information about extended invitations for the specified organization |
neon.neon_create_organization_invitations | Write write | 0 | Creates invitations for a specific organization. If the invited user has an existing account, they automatically join as a member. If they don't yet have an account, they are invited to create one, after which they become a member. Each invited user receives an email notification. |
neon.neon_transfer_projects_from_org_to_org | Write write | 0 | Transfers selected projects, identified by their IDs, from your organization to another specified organization. |
neon.neon_list_organization_v_p_c_endpoints_all_regions | Read read | 0 | Retrieves the list of VPC endpoints for the specified Neon organization across all regions. |
neon.neon_list_organization_v_p_c_endpoints | Read read | 0 | Retrieves the list of VPC endpoints for the specified Neon organization. |
neon.neon_get_organization_v_p_c_endpoint_details | Read read | 0 | Retrieves the current state and configuration details of a specified VPC endpoint. |
neon.neon_assign_organization_v_p_c_endpoint | Write write | 0 | Assigns a VPC endpoint to a Neon organization or updates its existing assignment. |
neon.neon_delete_organization_v_p_c_endpoint | Write write | 0 | Deletes the VPC endpoint from the specified Neon organization. If you delete a VPC endpoint from a Neon organization, that VPC endpoint cannot be added back to the Neon organization. |
neon.neon_get_active_regions | Read read | 0 | Lists supported Neon regions. Note: Not all regions are available to all organizations. Pass the orgid parameter to get an accurate list of regions available to your organization. |
neon.neon_get_current_user | Read read | 0 | Retrieves information about the current Neon user account. |
neon.neon_get_current_user_organizations | Read read | 0 | Retrieves information about the current Neon user's organizations |
neon.neon_transfer_projects_from_user_to_org | Write write | 0 | Transfers selected projects, identified by their IDs, from your personal account to a specified organization. |
neon.neon_get_auth_details | Read read | 0 | Returns auth information about the passed credentials. It can refer to an API key, Bearer token or OAuth session. |
neon.neon_create_snapshot | Write write | 0 | Create a snapshot from the specified branch using the provided parameters. This endpoint may initiate an asynchronous operation. Note: This endpoint is currently in Beta. |
neon.neon_list_snapshots | Read read | 0 | List the snapshots for the specified project. Note: This endpoint is currently in Beta. |
neon.neon_delete_snapshot | Write write | 0 | Delete the specified snapshot. Note: This endpoint is currently in Beta. |
neon.neon_update_snapshot | Write write | 0 | Update the specified snapshot. Note: This endpoint is currently in Beta. |
neon.neon_restore_snapshot | Write write | 0 | Restore the specified snapshot to a new branch and optionally finalize the restore operation. Note: This endpoint is currently in Beta. |
neon.neon_get_snapshot_schedule | Read read | 0 | View the backup schedule for the specified branch. Note: This endpoint is currently in Beta. |
neon.neon_set_snapshot_schedule | Write write | 0 | Update the backup schedule for the specified branch. Note : This endpoint is currently in Beta. |