KosmoKrator

data

Neon Lua API for KosmoKrator Agents

Agent-facing Lua documentation and function reference for the Neon KosmoKrator integration.

Lua Namespace

Agents call this integration through app.integrations.neon.*. Use lua_read_doc("integrations.neon") inside KosmoKrator to discover the same reference at runtime.

Call Lua from the Headless CLI

Use kosmo integrations:lua when a shell script, CI job, cron job, or another coding CLI should run a deterministic Neon workflow without starting an interactive agent session.

Inline Lua call 
kosmo integrations:lua --eval 'dump(app.integrations.neon.get_advisor_issues({}))' --json
Read Lua docs headlessly 
kosmo integrations:lua --eval 'print(docs.read("neon"))' --json
kosmo integrations:lua --eval 'print(docs.read("neon.get_advisor_issues"))' --json

Workflow file

Put repeatable logic in a Lua file, then execute it with JSON output for the calling process.

workflow.lua 
local neon = app.integrations.neon
local result = neon.get_advisor_issues({})

dump(result)
Run the workflow 
kosmo integrations:lua workflow.lua --json
kosmo integrations:lua workflow.lua --force --json
Namespace note. integrations:lua exposes app.integrations.neon, app.mcp.*, docs.*, json.*, and regex.*. Use app.integrations.neon.default.* or app.integrations.neon.work.* when you configured named credential accounts.

MCP-only Lua

If the script only needs configured MCP servers and does not need Neon, use the narrower mcp:lua command.

MCP Lua command 
# Use mcp:lua for MCP-only scripts; use integrations:lua for this integration namespace.
kosmo mcp:lua --eval 'dump(mcp.servers())' --json

Agent-Facing Lua Docs

This is the rendered version of the full Lua documentation exposed to agents when they inspect the integration namespace.

Neon Lua Docs

Namespace: neon

Neon tools call the official Neon API. Configure a Neon API key and use the default base URL https://console.neon.tech/api/v2 unless targeting a compatible endpoint. The API reference is documented at https://neon.com/docs/reference/api-reference.

This integration mirrors the official Neon OpenAPI document, including tools for API keys, projects, shared projects, operations, permissions, preload libraries, transfer requests, JWKS, Neon Auth, branches, Data API, databases, roles, compute endpoints, VPC endpoint restrictions, consumption history, organizations, billing spending limits, current user, and organization/project transfers.

Common tools:

local projects = neon.neon_list_projects({})

local project = neon.neon_get_project({
  project_id = "example-project-id"
})

local branches = neon.neon_list_branches({
  project_id = "example-project-id"
})

Request bodies can be passed as a body object. For JSON endpoints, loose arguments that are not path, query, or header parameters are also sent as the request body.

The generated tools preserve older common slugs such as neon_list_projects, neon_get_project, neon_create_project, neon_list_branches, neon_get_branch, neon_list_databases, and neon_get_current_user.

Use fake project ids, branch ids, organization ids, and API keys in examples and tests. Do not store real Neon API keys or private project identifiers in committed fixtures.

Raw agent markdown 
# Neon Lua Docs

Namespace: `neon`

Neon tools call the official Neon API. Configure a Neon API key and use the default base URL `https://console.neon.tech/api/v2` unless targeting a compatible endpoint. The API reference is documented at `https://neon.com/docs/reference/api-reference`.

This integration mirrors the official Neon OpenAPI document, including tools for API keys, projects, shared projects, operations, permissions, preload libraries, transfer requests, JWKS, Neon Auth, branches, Data API, databases, roles, compute endpoints, VPC endpoint restrictions, consumption history, organizations, billing spending limits, current user, and organization/project transfers.

Common tools:

```lua
local projects = neon.neon_list_projects({})

local project = neon.neon_get_project({
  project_id = "example-project-id"
})

local branches = neon.neon_list_branches({
  project_id = "example-project-id"
})
```

Request bodies can be passed as a `body` object. For JSON endpoints, loose arguments that are not path, query, or header parameters are also sent as the request body.

The generated tools preserve older common slugs such as `neon_list_projects`, `neon_get_project`, `neon_create_project`, `neon_list_branches`, `neon_get_branch`, `neon_list_databases`, and `neon_get_current_user`.

Use fake project ids, branch ids, organization ids, and API keys in examples and tests. Do not store real Neon API keys or private project identifiers in committed fixtures.
Metadata-derived Lua example 
local result = app.integrations.neon.get_advisor_issues({})
print(result)

Functions

get_advisor_issues Read

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.

Lua path
app.integrations.neon.get_advisor_issues
Full name
neon.neon_get_project_advisor_security_issues
ParameterTypeRequiredDescription
No parameters.
list_api_keys Read

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/.

Lua path
app.integrations.neon.list_api_keys
Full name
neon.neon_list_api_keys
ParameterTypeRequiredDescription
No parameters.
create_api_key Write

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/.

Lua path
app.integrations.neon.create_api_key
Full name
neon.neon_create_api_key
ParameterTypeRequiredDescription
No parameters.
revoke_api_key Write

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/.

Lua path
app.integrations.neon.revoke_api_key
Full name
neon.neon_revoke_api_key
ParameterTypeRequiredDescription
No parameters.
retrieve_operation_details Read

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.

Lua path
app.integrations.neon.retrieve_operation_details
Full name
neon.neon_get_project_operation
ParameterTypeRequiredDescription
No parameters.
list_projects Read

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/.

Lua path
app.integrations.neon.list_projects
Full name
neon.neon_list_projects
ParameterTypeRequiredDescription
No parameters.
create_project Write

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/.

Lua path
app.integrations.neon.create_project
Full name
neon.neon_create_project
ParameterTypeRequiredDescription
No parameters.
list_shared_projects Read

Retrieves a list of projects shared with your Neon account. For more information, see Manage projectshttps://neon.tech/docs/manage/projects/.

Lua path
app.integrations.neon.list_shared_projects
Full name
neon.neon_list_shared_projects
ParameterTypeRequiredDescription
No parameters.
retrieve_project_details Read

Retrieves information about the specified project. You can obtain a projectid by listing the projects for an organization.

Lua path
app.integrations.neon.retrieve_project_details
Full name
neon.neon_get_project
ParameterTypeRequiredDescription
No parameters.
update_project Write

Updates the specified project. You can obtain a projectid by listing the projects for your Neon account.

Lua path
app.integrations.neon.update_project
Full name
neon.neon_update_project
ParameterTypeRequiredDescription
No parameters.
delete_project Write

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.

Lua path
app.integrations.neon.delete_project
Full name
neon.neon_delete_project
ParameterTypeRequiredDescription
No parameters.
recover_deleted_project Write

Recovers a deleted project during the deletion grace period. You can obtain a projectid by listing the projects for your Neon account.

Lua path
app.integrations.neon.recover_deleted_project
Full name
neon.neon_recover_project
ParameterTypeRequiredDescription
No parameters.
list_operations Read

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.

Lua path
app.integrations.neon.list_operations
Full name
neon.neon_list_project_operations
ParameterTypeRequiredDescription
No parameters.
list_project_access Read

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.

Lua path
app.integrations.neon.list_project_access
Full name
neon.neon_list_project_permissions
ParameterTypeRequiredDescription
No parameters.
grant_project_access Write

Grants project access to the account associated with the specified email address

Lua path
app.integrations.neon.grant_project_access
Full name
neon.neon_grant_permission_to_project
ParameterTypeRequiredDescription
No parameters.
revoke_project_access Write

Revokes project access from the user associated with the specified permission id. You can retrieve a user's permission id by listing project access.

Lua path
app.integrations.neon.revoke_project_access
Full name
neon.neon_revoke_permission_from_project
ParameterTypeRequiredDescription
No parameters.
return_available_shared_preload_libraries Read

Return available shared preload libraries

Lua path
app.integrations.neon.return_available_shared_preload_libraries
Full name
neon.neon_get_available_preload_libraries
ParameterTypeRequiredDescription
No parameters.
create_project_transfer_request Write

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.

Lua path
app.integrations.neon.create_project_transfer_request
Full name
neon.neon_create_project_transfer_request
ParameterTypeRequiredDescription
No parameters.
accept_project_transfer_request Write

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.

Lua path
app.integrations.neon.accept_project_transfer_request
Full name
neon.neon_accept_project_transfer_request
ParameterTypeRequiredDescription
No parameters.
list_jwks_urls Read

Returns the JWKS URLs available for verifying JWTs used as the authentication mechanism for the specified project.

Lua path
app.integrations.neon.list_jwks_urls
Full name
neon.neon_get_project_j_w_k_s
ParameterTypeRequiredDescription
No parameters.
add_jwks_url Write

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.

Lua path
app.integrations.neon.add_jwks_url
Full name
neon.neon_add_project_j_w_k_s
ParameterTypeRequiredDescription
No parameters.
delete_jwks_url Write

Deletes a JWKS URL from the specified project

Lua path
app.integrations.neon.delete_jwks_url
Full name
neon.neon_delete_project_j_w_k_s
ParameterTypeRequiredDescription
No parameters.
create_data_api Write

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.

Lua path
app.integrations.neon.create_data_api
Full name
neon.neon_create_project_branch_data_a_p_i
ParameterTypeRequiredDescription
No parameters.
update_data_api Write

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.

Lua path
app.integrations.neon.update_data_api
Full name
neon.neon_update_project_branch_data_a_p_i
ParameterTypeRequiredDescription
No parameters.
delete_data_api Write

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.

Lua path
app.integrations.neon.delete_data_api
Full name
neon.neon_delete_project_branch_data_a_p_i
ParameterTypeRequiredDescription
No parameters.
get_data_api Read

Retrieves the Neon Data API for the specified branch.

Lua path
app.integrations.neon.get_data_api
Full name
neon.neon_get_project_branch_data_a_p_i
ParameterTypeRequiredDescription
No parameters.
create_auth_integration Write

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.

Lua path
app.integrations.neon.create_auth_integration
Full name
neon.neon_create_neon_auth_integration
ParameterTypeRequiredDescription
No parameters.
get_details_auth_branch Read

/ 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.

Lua path
app.integrations.neon.get_details_auth_branch
Full name
neon.neon_get_neon_auth
ParameterTypeRequiredDescription
No parameters.
enable_auth_branch Write

Enables Neon Auth integrationfor the branch. You can obtain the projectid and branchid by listing the projects and branches for your Neon account.

Lua path
app.integrations.neon.enable_auth_branch
Full name
neon.neon_create_neon_auth
ParameterTypeRequiredDescription
No parameters.
disables_auth_branch Write

Disables Neon Auth for the branch

Lua path
app.integrations.neon.disables_auth_branch
Full name
neon.neon_disable_neon_auth
ParameterTypeRequiredDescription
No parameters.
list_domains_redirecturi_whitelist Read

DEPRECATED, use /projects/{projectid}/branches/{branchid}/auth/domains instead. Lists the domains in the redirecturi whitelist for the specified project.

Lua path
app.integrations.neon.list_domains_redirecturi_whitelist
Full name
neon.neon_list_neon_auth_redirect_u_r_i_whitelist_domains
ParameterTypeRequiredDescription
No parameters.
add_domain_redirecturi_whitelist Write

DEPRECATED, use /projects/{projectid}/branches/{branchid}/auth/domains instead. Adds a domain to the redirecturi whitelist for the specified project.

Lua path
app.integrations.neon.add_domain_redirecturi_whitelist
Full name
neon.neon_add_neon_auth_domain_to_redirect_u_r_i_whitelist
ParameterTypeRequiredDescription
No parameters.
delete_domain_from_redirecturi_whitelist Write

DEPRECATED, use /projects/{projectid}/branches/{branchid}/auth/domains instead. Deletes a domain from the redirecturi whitelist for the specified project.

Lua path
app.integrations.neon.delete_domain_from_redirecturi_whitelist
Full name
neon.neon_delete_neon_auth_domain_from_redirect_u_r_i_whitelist
ParameterTypeRequiredDescription
No parameters.
list_domains_redirecturi_whitelist Read

Lists the domains in the redirecturi whitelist for the specified project.

Lua path
app.integrations.neon.list_domains_redirecturi_whitelist
Full name
neon.neon_list_branch_neon_auth_trusted_domains
ParameterTypeRequiredDescription
No parameters.
add_domain_redirecturi_whitelist Write

Adds a domain to the redirecturi whitelist for the specified project.

Lua path
app.integrations.neon.add_domain_redirecturi_whitelist
Full name
neon.neon_add_branch_neon_auth_trusted_domain
ParameterTypeRequiredDescription
No parameters.
delete_domain_from_redirecturi_whitelist Write

Deletes a domain from the redirecturi whitelist for the specified project.

Lua path
app.integrations.neon.delete_domain_from_redirecturi_whitelist
Full name
neon.neon_delete_branch_neon_auth_trusted_domain
ParameterTypeRequiredDescription
No parameters.
create_auth_provider_sdk_keys Write

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.

Lua path
app.integrations.neon.create_auth_provider_sdk_keys
Full name
neon.neon_create_neon_auth_provider_s_d_k_keys
ParameterTypeRequiredDescription
No parameters.
create_new_auth_user Write

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.

Lua path
app.integrations.neon.create_new_auth_user
Full name
neon.neon_create_neon_auth_new_user
ParameterTypeRequiredDescription
No parameters.
create_new_auth_user Write

Creates a new user in Neon Auth.

Lua path
app.integrations.neon.create_new_auth_user
Full name
neon.neon_create_branch_neon_auth_new_user
ParameterTypeRequiredDescription
No parameters.
delete_auth_user Write

Deletes the auth user for the specified project.

Lua path
app.integrations.neon.delete_auth_user
Full name
neon.neon_delete_branch_neon_auth_user
ParameterTypeRequiredDescription
No parameters.
update_auth_user_role Write

Updates the role of an auth user for the specified project.

Lua path
app.integrations.neon.update_auth_user_role
Full name
neon.neon_update_neon_auth_user_role
ParameterTypeRequiredDescription
No parameters.
delete_auth_user Write

DEPRECATED, use /projects/{projectid}/branches/{branchid}/auth/users/{authuserid} instead. Deletes the auth user for the specified project.

Lua path
app.integrations.neon.delete_auth_user
Full name
neon.neon_delete_neon_auth_user
ParameterTypeRequiredDescription
No parameters.
transfer_managed_auth_project_your_own_account Write

Transfer ownership of your Neon-managed auth project to your own auth provider account.

Lua path
app.integrations.neon.transfer_managed_auth_project_your_own_account
Full name
neon.neon_transfer_neon_auth_provider_project
ParameterTypeRequiredDescription
No parameters.
lists_active_integrations_with_auth_providers Read

DEPRECATED, use /projects/{projectid}/branches/{branchid}/auth instead.

Lua path
app.integrations.neon.lists_active_integrations_with_auth_providers
Full name
neon.neon_list_neon_auth_integrations
ParameterTypeRequiredDescription
No parameters.
list_oauth_providers Read

DEPRECATED, use /projects/{projectid}/branches/{branchid}/auth/oauthproviders instead. Lists the OAuth providers for the specified project.

Lua path
app.integrations.neon.list_oauth_providers
Full name
neon.neon_list_neon_auth_oauth_providers
ParameterTypeRequiredDescription
No parameters.
add_oauth_provider Write

DEPRECATED, use /projects/{projectid}/branches/{branchid}/auth/oauthproviders instead. Adds a OAuth provider to the specified project.

Lua path
app.integrations.neon.add_oauth_provider
Full name
neon.neon_add_neon_auth_oauth_provider
ParameterTypeRequiredDescription
No parameters.
list_oauth_providers_auth_branch Read

Lists the OAuth providers for the specified project and branch.

Lua path
app.integrations.neon.list_oauth_providers_auth_branch
Full name
neon.neon_list_branch_neon_auth_oauth_providers
ParameterTypeRequiredDescription
No parameters.
add_oauth_provider Write

Adds a OAuth provider to the specified project.

Lua path
app.integrations.neon.add_oauth_provider
Full name
neon.neon_add_branch_neon_auth_oauth_provider
ParameterTypeRequiredDescription
No parameters.
update_oauth_provider Write

DEPRECATED, use /projects/{projectid}/branches/{branchid}/auth/oauthproviders/{oauthproviderid} instead. Updates a OAuth provider for the specified project.

Lua path
app.integrations.neon.update_oauth_provider
Full name
neon.neon_update_neon_auth_oauth_provider
ParameterTypeRequiredDescription
No parameters.
delete_oauth_provider Write

DEPRECATED, use /projects/{projectid}/branches/{branchid}/auth/oauthproviders/{oauthproviderid} instead. Deletes a OAuth provider from the specified project.

Lua path
app.integrations.neon.delete_oauth_provider
Full name
neon.neon_delete_neon_auth_oauth_provider
ParameterTypeRequiredDescription
No parameters.
update_oauth_provider Write

Updates a OAuth provider for the specified project.

Lua path
app.integrations.neon.update_oauth_provider
Full name
neon.neon_update_branch_neon_auth_oauth_provider
ParameterTypeRequiredDescription
No parameters.
delete_oauth_provider Write

Deletes a OAuth provider from the specified project.

Lua path
app.integrations.neon.delete_oauth_provider
Full name
neon.neon_delete_branch_neon_auth_oauth_provider
ParameterTypeRequiredDescription
No parameters.
get_email_server_configuration Read

DEPRECATED, use /projects/{projectid}/branches/{branchid}/auth/emailprovider instead. Gets the email server configuration for the specified project.

Lua path
app.integrations.neon.get_email_server_configuration
Full name
neon.neon_get_neon_auth_email_server
ParameterTypeRequiredDescription
No parameters.
update_email_server_configuration Write

DEPRECATED, use /projects/{projectid}/branches/{branchid}/auth/emailprovider instead. Updates the email server configuration for the specified project.

Lua path
app.integrations.neon.update_email_server_configuration
Full name
neon.neon_update_neon_auth_email_server
ParameterTypeRequiredDescription
No parameters.
send_test_email Write

Sends a test email to the specified email address.

Lua path
app.integrations.neon.send_test_email
Full name
neon.neon_send_neon_auth_test_email
ParameterTypeRequiredDescription
No parameters.
get_email_and_password_configuration Read

Gets the email and password authentication configuration for Neon Auth

Lua path
app.integrations.neon.get_email_and_password_configuration
Full name
neon.neon_get_neon_auth_email_and_password_config
ParameterTypeRequiredDescription
No parameters.
update_email_and_password_configuration Write

Updates the email and password authentication configuration for Neon Auth

Lua path
app.integrations.neon.update_email_and_password_configuration
Full name
neon.neon_update_neon_auth_email_and_password_config
ParameterTypeRequiredDescription
No parameters.
get_email_provider_configuration Read

Gets the email provider configuration for the specified branch.

Lua path
app.integrations.neon.get_email_provider_configuration
Full name
neon.neon_get_neon_auth_email_provider
ParameterTypeRequiredDescription
No parameters.
update_email_provider_configuration Write

Updates the email provider configuration for the specified branch.

Lua path
app.integrations.neon.update_email_provider_configuration
Full name
neon.neon_update_neon_auth_email_provider
ParameterTypeRequiredDescription
No parameters.
delete_integration_with_auth_provider Write

DEPRECATED, use /projects/{projectid}/branches/{branchid}/auth instead.

Lua path
app.integrations.neon.delete_integration_with_auth_provider
Full name
neon.neon_delete_neon_auth_integration
ParameterTypeRequiredDescription
No parameters.
retrieve_connection_uri Read

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.

Lua path
app.integrations.neon.retrieve_connection_uri
Full name
neon.neon_get_connection_u_r_i
ParameterTypeRequiredDescription
No parameters.
get_allow_localhost Read

Get the allow localhost configuration for the specified branch.

Lua path
app.integrations.neon.get_allow_localhost
Full name
neon.neon_get_neon_auth_allow_localhost
ParameterTypeRequiredDescription
No parameters.
update_allow_localhost Write

Updates the allow localhost configuration for the specified branch.

Lua path
app.integrations.neon.update_allow_localhost
Full name
neon.neon_update_neon_auth_allow_localhost
ParameterTypeRequiredDescription
No parameters.
get_all_plugin_configurations Read

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.

Lua path
app.integrations.neon.get_all_plugin_configurations
Full name
neon.neon_get_neon_auth_plugin_configs
ParameterTypeRequiredDescription
No parameters.
update_organization_plugin_configuration Write

Updates the organization plugin configuration for Neon Auth. The organization plugin enables multi-tenant organization support.

Lua path
app.integrations.neon.update_organization_plugin_configuration
Full name
neon.neon_update_neon_auth_organization_plugin
ParameterTypeRequiredDescription
No parameters.
update_auth_configuration Write

Updates the auth configuration for the branch. Currently supports updating the application name used in auth emails.

Lua path
app.integrations.neon.update_auth_configuration
Full name
neon.neon_update_neon_auth_config
ParameterTypeRequiredDescription
No parameters.
get_phone_number_plugin_configuration Read

Returns the phone number plugin configuration for Neon Auth. The phone number plugin enables phone-based OTP authentication.

Lua path
app.integrations.neon.get_phone_number_plugin_configuration
Full name
neon.neon_get_neon_auth_phone_number_plugin
ParameterTypeRequiredDescription
No parameters.
update_phone_number_plugin_configuration Write

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.

Lua path
app.integrations.neon.update_phone_number_plugin_configuration
Full name
neon.neon_update_neon_auth_phone_number_plugin
ParameterTypeRequiredDescription
No parameters.
get_webhook_configuration_auth Read

Returns the webhook configuration for Neon Auth.

Lua path
app.integrations.neon.get_webhook_configuration_auth
Full name
neon.neon_get_neon_auth_webhook_config
ParameterTypeRequiredDescription
No parameters.
update_webhook_configuration_auth Write

Updates the webhook configuration for Neon Auth on a specific branch.

Lua path
app.integrations.neon.update_webhook_configuration_auth
Full name
neon.neon_update_neon_auth_webhook_config
ParameterTypeRequiredDescription
No parameters.
create_branch Write

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/.

Lua path
app.integrations.neon.create_branch
Full name
neon.neon_create_project_branch
ParameterTypeRequiredDescription
No parameters.
list_branches Read

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/.

Lua path
app.integrations.neon.list_branches
Full name
neon.neon_list_branches
ParameterTypeRequiredDescription
No parameters.
create_anonymized_branch Write

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.

Lua path
app.integrations.neon.create_anonymized_branch
Full name
neon.neon_create_project_branch_anonymized
ParameterTypeRequiredDescription
No parameters.
retrieve_number_branches Read

Retrieves the total number of branches in the specified project. You can obtain a projectid by listing the projects for your Neon account.

Lua path
app.integrations.neon.retrieve_number_branches
Full name
neon.neon_count_project_branches
ParameterTypeRequiredDescription
No parameters.
retrieve_branch_details Read

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/.

Lua path
app.integrations.neon.retrieve_branch_details
Full name
neon.neon_get_branch
ParameterTypeRequiredDescription
No parameters.
delete_branch Write

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.

Lua path
app.integrations.neon.delete_branch
Full name
neon.neon_delete_project_branch
ParameterTypeRequiredDescription
No parameters.
update_branch Write

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/.

Lua path
app.integrations.neon.update_branch
Full name
neon.neon_update_project_branch
ParameterTypeRequiredDescription
No parameters.
restore_branch Write

Restores a branch to an earlier state in its own or another branch's history

Lua path
app.integrations.neon.restore_branch
Full name
neon.neon_restore_project_branch
ParameterTypeRequiredDescription
No parameters.
retrieve_database_schema Read

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.

Lua path
app.integrations.neon.retrieve_database_schema
Full name
neon.neon_get_project_branch_schema
ParameterTypeRequiredDescription
No parameters.
compare_database_schema Read

Compares the schema from the specified database with another branch's schema.

Lua path
app.integrations.neon.compare_database_schema
Full name
neon.neon_get_project_branch_schema_comparison
ParameterTypeRequiredDescription
No parameters.
get_masking_rules Read

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.

Lua path
app.integrations.neon.get_masking_rules
Full name
neon.neon_get_masking_rules
ParameterTypeRequiredDescription
No parameters.
update_masking_rules Write

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.

Lua path
app.integrations.neon.update_masking_rules
Full name
neon.neon_update_masking_rules
ParameterTypeRequiredDescription
No parameters.
get_anonymized_branch_status Read

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.

Lua path
app.integrations.neon.get_anonymized_branch_status
Full name
neon.neon_get_anonymized_branch_status
ParameterTypeRequiredDescription
No parameters.
start_anonymization Write

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.

Lua path
app.integrations.neon.start_anonymization
Full name
neon.neon_start_anonymization
ParameterTypeRequiredDescription
No parameters.
set_branch_as_default Write

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/.

Lua path
app.integrations.neon.set_branch_as_default
Full name
neon.neon_set_default_project_branch
ParameterTypeRequiredDescription
No parameters.
recover_deleted_branch Write

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.

Lua path
app.integrations.neon.recover_deleted_branch
Full name
neon.neon_recover_project_branch
ParameterTypeRequiredDescription
No parameters.
finalize_restore Write

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.

Lua path
app.integrations.neon.finalize_restore
Full name
neon.neon_finalize_restore_branch
ParameterTypeRequiredDescription
No parameters.
list_branch_endpoints Read

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.

Lua path
app.integrations.neon.list_branch_endpoints
Full name
neon.neon_list_project_branch_endpoints
ParameterTypeRequiredDescription
No parameters.
list_databases Read

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/.

Lua path
app.integrations.neon.list_databases
Full name
neon.neon_list_databases
ParameterTypeRequiredDescription
No parameters.
create_database Write

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/.

Lua path
app.integrations.neon.create_database
Full name
neon.neon_create_project_branch_database
ParameterTypeRequiredDescription
No parameters.
retrieve_database_details Read

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/.

Lua path
app.integrations.neon.retrieve_database_details
Full name
neon.neon_get_project_branch_database
ParameterTypeRequiredDescription
No parameters.
update_database Write

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/.

Lua path
app.integrations.neon.update_database
Full name
neon.neon_update_project_branch_database
ParameterTypeRequiredDescription
No parameters.
delete_database Write

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/.

Lua path
app.integrations.neon.delete_database
Full name
neon.neon_delete_project_branch_database
ParameterTypeRequiredDescription
No parameters.
list_roles Read

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/.

Lua path
app.integrations.neon.list_roles
Full name
neon.neon_list_project_branch_roles
ParameterTypeRequiredDescription
No parameters.
create_role Write

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.

Lua path
app.integrations.neon.create_role
Full name
neon.neon_create_project_branch_role
ParameterTypeRequiredDescription
No parameters.
retrieve_role_details Read

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/.

Lua path
app.integrations.neon.retrieve_role_details
Full name
neon.neon_get_project_branch_role
ParameterTypeRequiredDescription
No parameters.
delete_role Write

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/.

Lua path
app.integrations.neon.delete_role
Full name
neon.neon_delete_project_branch_role
ParameterTypeRequiredDescription
No parameters.
retrieve_role_password Read

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/.

Lua path
app.integrations.neon.retrieve_role_password
Full name
neon.neon_get_project_branch_role_password
ParameterTypeRequiredDescription
No parameters.
reset_role_password Write

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/.

Lua path
app.integrations.neon.reset_role_password
Full name
neon.neon_reset_project_branch_role_password
ParameterTypeRequiredDescription
No parameters.
list_vpc_endpoint_restrictions Read

Lists VPC endpoint restrictions for the specified Neon project.

Lua path
app.integrations.neon.list_vpc_endpoint_restrictions
Full name
neon.neon_list_project_v_p_c_endpoints
ParameterTypeRequiredDescription
No parameters.
set_vpc_endpoint_restriction Write

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.

Lua path
app.integrations.neon.set_vpc_endpoint_restriction
Full name
neon.neon_assign_project_v_p_c_endpoint
ParameterTypeRequiredDescription
No parameters.
delete_vpc_endpoint_restriction Write

Removes the specified VPC endpoint restriction from a Neon project.

Lua path
app.integrations.neon.delete_vpc_endpoint_restriction
Full name
neon.neon_delete_project_v_p_c_endpoint
ParameterTypeRequiredDescription
No parameters.
create_compute_endpoint Write

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/.

Lua path
app.integrations.neon.create_compute_endpoint
Full name
neon.neon_create_project_endpoint
ParameterTypeRequiredDescription
No parameters.
list_compute_endpoints Read

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/.

Lua path
app.integrations.neon.list_compute_endpoints
Full name
neon.neon_list_project_endpoints
ParameterTypeRequiredDescription
No parameters.
retrieve_compute_endpoint_details Read

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/.

Lua path
app.integrations.neon.retrieve_compute_endpoint_details
Full name
neon.neon_get_project_endpoint
ParameterTypeRequiredDescription
No parameters.
delete_compute_endpoint Write

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/.

Lua path
app.integrations.neon.delete_compute_endpoint
Full name
neon.neon_delete_project_endpoint
ParameterTypeRequiredDescription
No parameters.
update_compute_endpoint Write

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.

Lua path
app.integrations.neon.update_compute_endpoint
Full name
neon.neon_update_project_endpoint
ParameterTypeRequiredDescription
No parameters.
start_compute_endpoint Write

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/.

Lua path
app.integrations.neon.start_compute_endpoint
Full name
neon.neon_start_project_endpoint
ParameterTypeRequiredDescription
No parameters.
suspend_compute_endpoint Write

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/.

Lua path
app.integrations.neon.suspend_compute_endpoint
Full name
neon.neon_suspend_project_endpoint
ParameterTypeRequiredDescription
No parameters.
restart_compute_endpoint Write

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/.

Lua path
app.integrations.neon.restart_compute_endpoint
Full name
neon.neon_restart_project_endpoint
ParameterTypeRequiredDescription
No parameters.
retrieve_account_consumption_metrics_legacy_plans Read

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.

Lua path
app.integrations.neon.retrieve_account_consumption_metrics_legacy_plans
Full name
neon.neon_get_consumption_history_per_account
ParameterTypeRequiredDescription
No parameters.
retrieve_project_consumption_metrics_legacy_plans Read

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.

Lua path
app.integrations.neon.retrieve_project_consumption_metrics_legacy_plans
Full name
neon.neon_get_consumption_history_per_project
ParameterTypeRequiredDescription
No parameters.
retrieve_project_consumption_metrics Read

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.

Lua path
app.integrations.neon.retrieve_project_consumption_metrics
Full name
neon.neon_get_consumption_history_per_project_v2
ParameterTypeRequiredDescription
No parameters.
retrieve_organization_details Read

Retrieves information about the specified organization.

Lua path
app.integrations.neon.retrieve_organization_details
Full name
neon.neon_get_organization
ParameterTypeRequiredDescription
No parameters.
list_organization_api_keys Read

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/.

Lua path
app.integrations.neon.list_organization_api_keys
Full name
neon.neon_list_org_api_keys
ParameterTypeRequiredDescription
No parameters.
create_organization_api_key Write

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/.

Lua path
app.integrations.neon.create_organization_api_key
Full name
neon.neon_create_org_api_key
ParameterTypeRequiredDescription
No parameters.
revoke_organization_api_key Write

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/.

Lua path
app.integrations.neon.revoke_organization_api_key
Full name
neon.neon_revoke_org_api_key
ParameterTypeRequiredDescription
No parameters.
retrieve_organization_monthly_spending_limit Read

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.

Lua path
app.integrations.neon.retrieve_organization_monthly_spending_limit
Full name
neon.neon_get_organization_spending_limit
ParameterTypeRequiredDescription
No parameters.
set_organization_monthly_spending_limit Write

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.

Lua path
app.integrations.neon.set_organization_monthly_spending_limit
Full name
neon.neon_set_organization_spending_limit
ParameterTypeRequiredDescription
No parameters.
clear_organization_monthly_spending_limit Write

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.

Lua path
app.integrations.neon.clear_organization_monthly_spending_limit
Full name
neon.neon_delete_organization_spending_limit
ParameterTypeRequiredDescription
No parameters.
retrieve_organization_members_details Read

Retrieves a paginated list of members for the specified organization.

Lua path
app.integrations.neon.retrieve_organization_members_details
Full name
neon.neon_get_organization_members
ParameterTypeRequiredDescription
No parameters.
retrieve_organization_member_details Read

Retrieves information about the specified organization member.

Lua path
app.integrations.neon.retrieve_organization_member_details
Full name
neon.neon_get_organization_member
ParameterTypeRequiredDescription
No parameters.
update_role_organization_member Write

Only an admin can perform this action.

Lua path
app.integrations.neon.update_role_organization_member
Full name
neon.neon_update_organization_member
ParameterTypeRequiredDescription
No parameters.
remove_member_from_organization Write

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.

Lua path
app.integrations.neon.remove_member_from_organization
Full name
neon.neon_remove_organization_member
ParameterTypeRequiredDescription
No parameters.
retrieve_organization_invitation_details Read

Retrieves information about extended invitations for the specified organization

Lua path
app.integrations.neon.retrieve_organization_invitation_details
Full name
neon.neon_get_organization_invitations
ParameterTypeRequiredDescription
No parameters.
create_organization_invitations Write

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.

Lua path
app.integrations.neon.create_organization_invitations
Full name
neon.neon_create_organization_invitations
ParameterTypeRequiredDescription
No parameters.
transfer_projects_between_organizations Write

Transfers selected projects, identified by their IDs, from your organization to another specified organization.

Lua path
app.integrations.neon.transfer_projects_between_organizations
Full name
neon.neon_transfer_projects_from_org_to_org
ParameterTypeRequiredDescription
No parameters.
list_vpc_endpoints_across_all_regions Read

Retrieves the list of VPC endpoints for the specified Neon organization across all regions.

Lua path
app.integrations.neon.list_vpc_endpoints_across_all_regions
Full name
neon.neon_list_organization_v_p_c_endpoints_all_regions
ParameterTypeRequiredDescription
No parameters.
list_vpc_endpoints Read

Retrieves the list of VPC endpoints for the specified Neon organization.

Lua path
app.integrations.neon.list_vpc_endpoints
Full name
neon.neon_list_organization_v_p_c_endpoints
ParameterTypeRequiredDescription
No parameters.
retrieve_vpc_endpoint_details Read

Retrieves the current state and configuration details of a specified VPC endpoint.

Lua path
app.integrations.neon.retrieve_vpc_endpoint_details
Full name
neon.neon_get_organization_v_p_c_endpoint_details
ParameterTypeRequiredDescription
No parameters.
assign_or_update_vpc_endpoint Write

Assigns a VPC endpoint to a Neon organization or updates its existing assignment.

Lua path
app.integrations.neon.assign_or_update_vpc_endpoint
Full name
neon.neon_assign_organization_v_p_c_endpoint
ParameterTypeRequiredDescription
No parameters.
delete_vpc_endpoint Write

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.

Lua path
app.integrations.neon.delete_vpc_endpoint
Full name
neon.neon_delete_organization_v_p_c_endpoint
ParameterTypeRequiredDescription
No parameters.
list_supported_regions Read

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.

Lua path
app.integrations.neon.list_supported_regions
Full name
neon.neon_get_active_regions
ParameterTypeRequiredDescription
No parameters.
retrieve_current_user_details Read

Retrieves information about the current Neon user account.

Lua path
app.integrations.neon.retrieve_current_user_details
Full name
neon.neon_get_current_user
ParameterTypeRequiredDescription
No parameters.
retrieve_current_user_organizations_list Read

Retrieves information about the current Neon user's organizations

Lua path
app.integrations.neon.retrieve_current_user_organizations_list
Full name
neon.neon_get_current_user_organizations
ParameterTypeRequiredDescription
No parameters.
transfer_projects_from_personal_account_organization Write

Transfers selected projects, identified by their IDs, from your personal account to a specified organization.

Lua path
app.integrations.neon.transfer_projects_from_personal_account_organization
Full name
neon.neon_transfer_projects_from_user_to_org
ParameterTypeRequiredDescription
No parameters.
get_request_authentication_details Read

Returns auth information about the passed credentials. It can refer to an API key, Bearer token or OAuth session.

Lua path
app.integrations.neon.get_request_authentication_details
Full name
neon.neon_get_auth_details
ParameterTypeRequiredDescription
No parameters.
create_snapshot Write

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.

Lua path
app.integrations.neon.create_snapshot
Full name
neon.neon_create_snapshot
ParameterTypeRequiredDescription
No parameters.
list_project_snapshots Read

List the snapshots for the specified project. Note: This endpoint is currently in Beta.

Lua path
app.integrations.neon.list_project_snapshots
Full name
neon.neon_list_snapshots
ParameterTypeRequiredDescription
No parameters.
delete_snapshot Write

Delete the specified snapshot. Note: This endpoint is currently in Beta.

Lua path
app.integrations.neon.delete_snapshot
Full name
neon.neon_delete_snapshot
ParameterTypeRequiredDescription
No parameters.
update_snapshot Write

Update the specified snapshot. Note: This endpoint is currently in Beta.

Lua path
app.integrations.neon.update_snapshot
Full name
neon.neon_update_snapshot
ParameterTypeRequiredDescription
No parameters.
restore_snapshot Write

Restore the specified snapshot to a new branch and optionally finalize the restore operation. Note: This endpoint is currently in Beta.

Lua path
app.integrations.neon.restore_snapshot
Full name
neon.neon_restore_snapshot
ParameterTypeRequiredDescription
No parameters.
view_backup_schedule Read

View the backup schedule for the specified branch. Note: This endpoint is currently in Beta.

Lua path
app.integrations.neon.view_backup_schedule
Full name
neon.neon_get_snapshot_schedule
ParameterTypeRequiredDescription
No parameters.
update_backup_schedule Write

Update the backup schedule for the specified branch. Note : This endpoint is currently in Beta.

Lua path
app.integrations.neon.update_backup_schedule
Full name
neon.neon_set_snapshot_schedule
ParameterTypeRequiredDescription
No parameters.