neon

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

Creates an API key. The key_name 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 keys.

Revokes the specified API key. An API key that is no longer needed can be revoked. This action cannot be reversed. You can obtain key_id values by listing the API keys for your Neon account. API keys can also be managed in the Neon Console. See Manage API keys.

Retrieves details for the specified operation. An operation is an action performed on a Neon project resource. You can obtain a project_id by listing the projects for your Neon account. You can obtain a operation_id by listing operations for the project.

Retrieves a list of projects for the Neon account. A project is the top-level object in the Neon object hierarchy. For more information, see Manage projects.

Creates a Neon project. A project is the top-level object in the Neon object hierarchy. Plan limits define how many projects you can create. Neon's Free plan permits one project per Neon account. For more information, see Manage projects.

You can specify a region and PostgreSQL version in the request body. Neon currently supports PostgreSQL 14 and 15. For supported regions and region_id values, see Regions.

Retrieves information about the specified project. A project is the top-level object in the Neon object hierarchy. You can obtain a project_id by listing the projects for your Neon account.

Deletes the specified project. You can obtain a project_id 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.

Updates the specified project. You can obtain a project_id by listing the projects for your Neon account. Neon permits updating the project name only.

Retrieves a list of operations for the specified Neon project. You can obtain a project_id 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.

Retrieves a list of branches for the specified project. You can obtain a project_id by listing the projects for your Neon account.

Each Neon project has a root branch named main. A branch_id 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 parent_id value, which is the id of the parent branch. For related information, see Manage branches.

Creates a branch in the specified project. You can obtain a project_id by listing the projects for your Neon account.

This method does not require a request body, but you can specify one to create an endpoint for the branch or to select a non-default parent branch. The default behavior is to create a branch from the project's root branch (main) with no endpoint, and the branch name is auto-generated. For related information, see Manage branches.

Retrieves information about the specified branch. You can obtain a project_id by listing the projects for your Neon account. You can obtain a branch_id by listing the project's branches. A branch_id value has a br- prefix.

Each Neon project has a root branch named main. A project may contain child branches that were branched from main or from another branch. A parent branch is identified by a parent_id value, which is the id of the parent branch. For related information, see Manage branches.

Deletes the specified branch from a project, and places all endpoints into an idle state, breaking existing client connections. You can obtain a project_id by listing the projects for your Neon account. You can obtain a branch_id by listing the project's branches. For related information, see Manage branches.

When a successful response status is received, the endpoints are still active, and the branch is not yet deleted from storage. The deletion occurs after all operations finish. You cannot delete a branch if it is the only remaining branch in the project. A project must have at least one branch.

Updates the specified branch. Only changing the branch name is supported. You can obtain a project_id by listing the projects for your Neon account. You can obtain the branch_id by listing the project's branches. For more information, see Manage branches.

The primary mark is automatically removed from the previous primary branch. You can obtain a project_id by listing the projects for your Neon account. You can obtain the branch_id by listing the project's branches. For more information, see Manage branches.

Retrieves a list of endpoints for the specified branch. Currently, Neon permits only one endpoint per branch. You can obtain a project_id by listing the projects for your Neon account. You can obtain the branch_id by listing the project's branches.

Retrieves a list of databases for the specified branch. A branch can have multiple databases. You can obtain a project_id by listing the projects for your Neon account. You can obtain the branch_id by listing the project's branches. For related information, see Manage databases.

Creates a database in the specified branch. A branch can have multiple databases. You can obtain a project_id by listing the projects for your Neon account. You can obtain the branch_id by listing the project's branches. For related information, see Manage databases.

Retrieves information about the specified database. You can obtain a project_id by listing the projects for your Neon account. You can obtain the branch_id and database_name by listing branch's databases. For related information, see Manage databases.

Deletes the specified database from the branch. You can obtain a project_id by listing the projects for your Neon account. You can obtain the branch_id and database_name by listing branch's databases. For related information, see Manage databases.

Updates the specified database in the branch. You can obtain a project_id by listing the projects for your Neon account. You can obtain the branch_id and database_name by listing the branch's databases. For related information, see Manage databases.

Retrieves a list of roles from the specified branch. You can obtain a project_id by listing the projects for your Neon account. You can obtain the branch_id by listing the project's branches. In Neon, the terms "role" and "user" are synonymous. For related information, see Manage users.

Creates a role in the specified branch. You can obtain a project_id by listing the projects for your Neon account. You can obtain the branch_id by listing the project's branches. In Neon, the terms "role" and "user" are synonymous. For related information, see Manage users.

Connections established to the active read-write endpoint will be dropped. If the read-write endpoint is idle, the endpoint becomes active for a short period of time and is suspended afterward.

Retrieves details about the specified role. You can obtain a project_id by listing the projects for your Neon account. You can obtain the branch_id by listing the project's branches. You can obtain the role_name by listing the roles for a branch. In Neon, the terms "role" and "user" are synonymous. For related information, see Managing users.

Deletes the specified role from the branch. You can obtain a project_id by listing the projects for your Neon account. You can obtain the branch_id by listing the project's branches. You can obtain the role_name by listing the roles for a branch. In Neon, the terms "role" and "user" are synonymous. For related information, see Managing users.

Retrieves password of the specified role if possible. You can obtain a project_id by listing the projects for your Neon account. You can obtain the branch_id by listing the project's branches. You can obtain the role_name by listing the roles for a branch. In Neon, the terms "role" and "user" are synonymous. For related information, see Managing users.

Resets the password for the specified 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 read-write endpoint are dropped. If idle, the read-write endpoint becomes active for a short period of time.

You can obtain a project_id by listing the projects for your Neon account. You can obtain the branch_id by listing the project's branches. You can obtain the role_name by listing the roles for a branch. In Neon, the terms "role" and "user" are synonymous. For related information, see Managing users.

Retrieves a list of endpoints for the specified project. An endpoint is a Neon compute instance. You can obtain a project_id by listing the projects for your Neon account. For more information about endpoints, see Manage endpoints.

Creates an endpoint for the specified branch. An endpoint is a Neon compute instance. There is a maximum of one endpoint per branch. If the specified branch already has an endpoint, the operation fails.

You can obtain a project_id by listing the projects for your Neon account. You can obtain branch_id by listing the project's branches. A branch_id has a br- prefix. Currently, only the read_write endpoint type is supported. For supported regions and region_id values, see Regions. For more information about endpoints, see Manage endpoints.

Retrieves information about the specified endpoint. An endpoint is a Neon compute instance. You can obtain a project_id by listing the projects for your Neon account. You can obtain an endpoint_id by listing your project's endpoints. An endpoint_id has an ep- prefix. For more information about endpoints, see Manage endpoints.

Delete the specified endpoint. An endpoint is a Neon compute instance. Deleting an endpoint drops existing network connections to the endpoint. The deletion is completed when last operation in the chain finishes successfully.

You can obtain a project_id by listing the projects for your Neon account. You can obtain an endpoint_id by listing your project's endpoints. An endpoint_id has an ep- prefix. For more information about endpoints, see Manage endpoints.

Updates the specified endpoint. Currently, only changing the associated branch is supported. The branch that you specify cannot have an existing endpoint.

You can obtain a project_id by listing the projects for your Neon account. You can obtain an endpoint_id and branch_id by listing your project's endpoints. An endpoint_id has an ep- prefix. A branch_id has a br- prefix. For more information about endpoints, see Manage endpoints.

If the returned list of operations is not empty, the endpoint is not ready to use. The client must wait for the last operation to finish before using the endpoint. If the endpoint was idle before the update, the endpoint becomes active for a short period of time, and the control plane suspends it again after the update.

Starts an endpoint. The endpoint is ready to use after the last operation in chain finishes successfully.

You can obtain a project_id by listing the projects for your Neon account. You can obtain an endpoint_id by listing your project's endpoints. An endpoint_id has an ep- prefix. For more information about endpoints, see Manage endpoints.

Suspend the specified endpoint You can obtain a project_id by listing the projects for your Neon account. You can obtain an endpoint_id by listing your project's endpoints. An endpoint_id has an ep- prefix. For more information about endpoints, see Manage endpoints.

Note, this is a preview API and could be subjected to significant changes in the future. Retrieves a list of per-project consumption for the current billing period.