Neon integration

Fetch database for branch

Retrieves a list of databases associated with a specific project and branch in the neon platform. this endpoint allows developers to view all databases within a particular project and branch context, which is useful for managing different environments (e.g., development, staging, production) or versions of an application's database setup. it should be used when you need to inventory the databases in a specific branch or verify the existence of databases in a particular project environment. the endpoint does not provide detailed information about each database's schema or contents; it's primarily for listing purposes.

Fetch organization members by id

Retrieves a list of all members associated with a specific organization in the neon b2b saas integration platform. this endpoint allows you to fetch detailed information about the users or entities that belong to the organization, which is crucial for managing access, roles, and permissions within the platform. use this endpoint when you need to review the current membership of an organization, audit user access, or gather member information for reporting purposes. the endpoint returns comprehensive member details, but it does not modify any data or provide information about non-member users. keep in mind that for large organizations, the response may be paginated to manage the data volume efficiently.

Fetch vpcendpoint details by id

Retrieves detailed information about a specific vpc endpoint within an organization's infrastructure in a particular aws region. this endpoint allows developers to access configuration details, status, and other relevant information about the vpc endpoint, which is crucial for managing private connectivity between vpcs and supported aws services. use this endpoint when you need to inspect or verify the settings of a vpc endpoint, troubleshoot connectivity issues, or gather information for compliance and auditing purposes. the endpoint provides a comprehensive view of the vpc endpoint's current state but does not allow modifications to the endpoint configuration.

Get branches for project

Retrieves a list of branches associated with a specific project in the neon b2b saas integration platform. this endpoint should be used when you need to get an overview of all branches within a particular project, which is useful for version management and workflow control. it provides information about different versions or development stages of the project, allowing for efficient project management and collaboration. the endpoint is particularly helpful when planning merges, reviewing project history, or deciding on which branch to base new development work.

Get branch roles for project

Retrieves the roles associated with a specific branch within a project in the neon b2b saas integration platform. this endpoint is used to fetch the current role assignments for a given project and branch combination, which is essential for managing access control and permissions within the neon ecosystem. it should be used when you need to review or audit the roles assigned to a particular branch, such as before making changes to permissions or when verifying the current access structure. the endpoint does not modify any roles; it only provides a read-only view of the existing role assignments. keep in mind that the response will only include roles for the specified branch and does not provide information about roles in other branches or at the project level.

Get consumption history projects

Retrieves the consumption history for specified projects within the neon platform. this endpoint allows users to fetch detailed metrics about resource usage over time, enabling effective monitoring and analysis of project-level consumption. it's particularly useful for tracking costs, identifying usage patterns, and optimizing resource allocation across different projects. the endpoint supports querying data for specific time periods and can provide aggregated data at various granularities (e.g., hourly, daily, monthly). while it offers comprehensive consumption data, it does not provide real-time usage information or predictive analytics.

Get current user information

Retrieves the profile information for the currently authenticated user. this endpoint should be used when you need to access details about the user making the api request, such as their username, email, or other account-related information. it's particularly useful for personalizing user experiences or retrieving user-specific settings within the neon platform. the endpoint doesn't accept any parameters, as it relies solely on the authentication token to identify the user. note that this endpoint will only return information for the authenticated user and cannot be used to retrieve profiles of other users.

Get organization api keys

Retrieves a list of all api keys associated with a specific organization in the neon b2b saas integration platform. this endpoint is crucial for administrators to manage and monitor api access within their organization. it provides a comprehensive view of all active api keys, enabling effective access control and security auditing. use this endpoint when you need to review, track, or manage the api keys in use by your organization, such as during security reviews or when updating access permissions.

Get project branches

Retrieves detailed information about a specific branch within a neon project. this endpoint allows developers to fetch the current state and configuration of a branch, including its name, creation timestamp, and other relevant metadata. it's particularly useful when you need to verify branch details, check its status, or gather information for further operations on the branch. the endpoint should be used when you require up-to-date information about a single branch in your project's context. note that this endpoint only provides read access and does not modify any branch data.

Get project branch role

Retrieves detailed information about a specific role within a particular branch of a neon project. this endpoint is used to fetch the current configuration, permissions, and other relevant details associated with the specified role. it's particularly useful for auditing access controls, verifying role settings, or gathering information before making modifications to role permissions. the endpoint requires precise identification of the project, branch, and role, ensuring that the correct role information is retrieved from the appropriate context within the neon platform's hierarchical structure.

Get project connection uri

Retrieves the connection uri for a specified project within the neon b2b saas integration platform. this endpoint is crucial for establishing connectivity to a project's resources, enabling access to its data and functionalities. use this when you need to programmatically obtain the connection details for a specific project, which is essential for integrating with the project's data sources or services. the connection uri serves as a unique identifier and access point for the project, facilitating seamless data exchange and workflow automation between different systems and applications within the neon ecosystem.

Get project endpoint information

Retrieves a list of all endpoints associated with a specific project in the neon b2b saas integration platform. this endpoint should be used when you need to obtain information about the available integration points or data connections within a particular project. it provides an overview of the project's configured endpoints, which can be useful for monitoring, auditing, or managing the project's integration setup. the response likely includes details such as endpoint names, types, and statuses, though the exact structure is not specified in the given schema. this endpoint is essential for developers and administrators working with multiple integrations within a single project in the neon platform.

Access project details by id

Retrieves detailed information about a specific project within the neon b2b saas integration platform. this endpoint is used to fetch comprehensive data about a project, including its configuration, associated workflows, and current status. it's particularly useful when you need to review or analyze the settings and progress of an integration project. the endpoint should be used when detailed project information is required, such as during troubleshooting, reporting, or when preparing to make updates to a project. it does not modify any project data and is safe for frequent calls. however, it may not provide real-time updates for ongoing integration processes; for that, a separate status or logs endpoint might be more appropriate.

Add new jwks to project endpoint

Adds a new json web key set (jwks) to a specific endpoint of a project in the neon b2b saas integration platform. this endpoint is crucial for setting up secure authentication and authorization mechanisms, allowing seamless integration with various identity providers. use this when configuring a new authentication source or updating existing jwks information for your project. the endpoint supports multiple authentication providers and allows for branch-specific configurations and role mappings. note that a maximum of 10 role names can be associated with each jwks.

Add project email permission

Adds permissions for a specified email address to a particular project within the neon b2b saas integration platform. this endpoint is used to grant access or specific rights to users for a given project, enabling collaboration and controlled resource sharing. it should be called when you need to add a new user to a project or modify existing user permissions. the endpoint associates the provided email with the specified project, likely setting up default or predefined permission levels. note that this endpoint only adds permissions and does not provide information about existing permissions or remove them.

Add role to branch

Creates a new role within a specific branch of a project in the neon b2b saas integration platform. this endpoint allows for fine-grained access control by enabling the creation of custom roles at the branch level. it should be used when setting up or modifying the permission structure for a particular branch within a project. the created role can later be assigned to users, granting them specific permissions within the branch context. note that this endpoint only creates the role; additional steps may be required to assign permissions to the role or associate it with users.

Create api key for organization

Creates a new api key for the specified organization, with optional project-specific access limitations. this endpoint is used to generate and manage api keys, which are essential for authenticating and authorizing access to neon's b2b saas integration platform. the created api key can be used to interact with various services and endpoints within the organization's scope. if a project id is provided, the api key's access will be restricted to that specific project, enabling fine-grained access control. this is particularly useful in multi-project environments where different teams or integrations require isolated access. the endpoint requires a key name to be specified, allowing for easy identification and management of multiple api keys within the organization. it's important to note that the actual api key value will be returned in the response, and should be securely stored as it cannot be retrieved later.

Create branch database

Creates a new database within a specified project and branch in the neon platform. this endpoint allows users to set up a new database with a custom name and assign an owner role, facilitating the organization and management of databases within the neon ecosystem. it should be used when initializing a new database for a specific project or when branching requires a separate database instance. the endpoint is particularly useful for developers and database administrators who need to quickly set up new databases as part of their workflow or application deployment process. note that this operation only creates the database; additional steps may be required to configure specific schemas, tables, or access permissions within the newly created database.

Create compute endpoint

Creates a new compute endpoint for a specified branch within a neon project. this endpoint allows for detailed configuration of database resources, including read/write capabilities, regional placement, autoscaling limits, and connection pooling settings. it's primarily used when setting up new database instances or modifying existing database configurations to meet specific performance, scaling, or operational requirements. the endpoint provides fine-grained control over compute resources, enabling optimized database operations for various use cases from development to production environments.

Create new api key

Creates a new api key for accessing the neon b2b saas integration platform. this endpoint should be used when setting up new integrations, creating separate keys for different environments (e.g., production, testing), or rotating existing keys for security purposes. the created api key will be used for authenticating and authorizing requests to other neon api endpoints. note that this endpoint only creates the key; it does not manage permissions or access levels, which must be configured separately. after creation, ensure the key is securely stored, as it may not be retrievable in plain text again.

Create new project branch

Creates a new branch in a neon project with optional compute endpoints. this endpoint allows you to specify the parent branch, branch name, and various configuration options for both the branch and its compute endpoints. it can be used to create development environments, test new features, or set up isolated database instances. the endpoint supports advanced features like autoscaling, custom provisioners, and suspend timeout configuration for optimizing resource usage and performance.

Create project with quota and settings

Creates a new neon project with specified configuration settings. this endpoint allows you to set up a customized postgresql environment with various options for resource management, networking, and performance optimization. it's ideal for initializing a new database project with tailored settings for quota management, ip access control, autoscaling, and more. use this when you need to establish a new neon project with specific requirements or when you want to take advantage of neon's advanced features like logical replication or custom maintenance windows. note that some settings, once configured, may not be easily changed later, so careful consideration of your project needs is recommended before creation.

Create vpc endpoint label

Updates the label of a specific vpc endpoint within a project in the neon b2b saas integration platform. this endpoint allows users to modify the identifier of an existing vpc endpoint, enhancing organization and management of network resources. it should be used when there's a need to rename or re-categorize a vpc endpoint for better clarity or changed purposes. the operation is idempotent, meaning repeated calls with the same label will not create additional changes. note that this endpoint only updates the label and does not modify any other properties or configurations of the vpc endpoint.

Create vpc endpoint with label

Updates the label of a specific vpc endpoint within an organization's virtual private cloud (vpc) in a particular aws region. this endpoint allows you to change the descriptive name or identifier associated with a vpc endpoint, which can be useful for better organization and management of your vpc resources. the new label helps in identifying and categorizing the vpc endpoint within your infrastructure. this endpoint should be used when you need to modify the existing label of a vpc endpoint, perhaps due to changes in its purpose or to align with updated naming conventions in your organization. it's important to note that this operation only updates the label and does not affect the functionality or configuration of the vpc endpoint itself.