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.
This API reference has movedThe Neon API reference now lives in the main Neon documentation at https://neon.com/docs/reference/api. Please update your bookmarks.
This site (api-docs.neon.tech) is deprecated and will be retired soon. It is no longer maintained, so it may be out of date.
The Neon API itself is not deprecated. It is fully supported and unchanged. Only this hosted reference site is going away.
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
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.