This page will help you get started with the Neon API
Introduction
The Neon API allows you to manage Neon programmatically. With the Neon API, you manage all objects in your Neon account, including:
- API keys
- Operations
- Projects
- Branches
- Compute endpoints
- Databases
- Roles
- Regions
- Users
- Consumption
- Organizations
Databases and roles belong to branches and are therefore managed with Branch endpoints. Look under Branch in the sidebar for database and role endpoints.
For information about the Neon objects listed above, refer to Overview of the Neon object hierarchy, in the Neon documentation.
Neon API base URL
The base URL for a Neon API request is:
https://console.neon.tech/api/v2/
Append a Neon API endpoint path to the base URL to construct the full URL for a request. For example:
https://console.neon.tech/api/v2/projects/{project_id}/branches/{branch_id}
Neon OpenAPI Specification
You can find the Neon OpenAPI specification here in JSON format: Neon OpenAPI specification
Neon API examples
For Neon API examples, refer to the following topics in the Neon documentation:
- Manage API keys with the Neon API
- Manage projects with the Neon API
- Manage branches with the Neon API
- Manage compute endpoints with the Neon API
- Manage roles with the Neon API
- Manage databases with the Neon API
- View operations with the Neon API
- Manage Organizations using the Neon API
- Query consumption metrics
When using the Neon API programmatically, you can poll the operation status to ensure that an operation is finished before proceeding with the next API request. For more information, see Poll operation status.
Need help?
Join our Discord Server to ask questions or see what others are doing with Neon. Users on paid plans can open a support ticket from the console. For more details, see Getting Support.