Skip to main content
Neon Postgres Docs
current

Search documentation

Type to search this documentation.

On this pageOverview

Neon API

Browse all Neon API endpoints by resource, or get started with authentication and your first request.

The Neon API lets you manage Neon programmatically. You can create and manage projects, branches, databases, roles, compute endpoints, API keys, and more. Everything you can do in the Neon Console, you can do with the API.

Browse endpoints below, start with Get started, download the OpenAPI spec, or load api.md as AI context.

Use the endpoint index to search every generated API operation, or browse by resource below.

179 endpoints across 19 resources

Search endpoint index

AI Gateway1 Retrieve branch AI Gateway endpointsAPI Keys3 Create and revoke API keysAuthentication29 Neon Auth configuration and user managementBranches28 Copy-on-write database clones for dev, test, and CI/CDBuckets8 Manage branch buckets and objectsConsumption3 Query billing and usage metricsCredentials5 Issue and revoke scoped branch credentialsData API5 RESTful access to your databaseEndpoints8 Compute instances that run your Postgres workloadFunctions13 Manage branch functions and deploymentsLogs3 Query logs emitted by services running on branchesOperations2 Track async operation statusOrganizations19 Manage org members, API keys, VPC endpoints, and spendingProjects23 Create, manage, and delete Neon projectsRegions1 List supported deployment regionsSnapshots7 Point-in-time backup and restoreStorage1 Inspect branch storage stateUsers4 Current user details and org membershipLegacy Auth16 Deprecated Neon Auth endpoints; use the Auth endpoints instead

If you don't need to call the REST API directly, use one of these interfaces instead.

Suggest an edit

Propose a replacement for this page. The site team reviews it before applying any changes.

Export
Documentation menu