Jump to Content
Neon OpenAPI Specification
Neon Docs
Neon Console
Discord
API Reference
v2.0
Neon OpenAPI Specification
Neon Docs
Neon Console
Discord
API Reference
Moon (Dark Mode)
Sun (Light Mode)
v2.0
API Reference
List supported regions
Search
JUMP TO
Neon API
Neon API Reference
Use cases
Authentication
Pagination
Path parameters
SDKs and providers for the Neon API
Neon API for AI Agents
Neon API
API Key
List API keys
get
Create API key
post
Revoke API key
delete
Operation
Retrieve operation details
get
List operations
get
Project
List projects
get
Create project
post
List shared projects
get
Retrieve project details
get
Update project
patch
Delete project
delete
List project access
get
Grant project access
post
Revoke project access
delete
Return available shared preload libraries
get
Create a project transfer request
post
Accept a project transfer request
put
List JWKS URLs
get
Add JWKS URL
post
Delete JWKS URL
delete
Retrieve connection URI
get
List VPC endpoint restrictions
get
Set VPC endpoint restriction
post
Delete VPC endpoint restriction
delete
Branch
Create branch
post
List branches
get
Retrieve number of branches
get
Retrieve branch details
get
Delete branch
delete
Update branch
patch
Restore branch
post
Retrieve database schema
get
Compare database schema
get
Set branch as default
post
List branch endpoints
get
List databases
get
Create database
post
Retrieve database details
get
Update database
patch
Delete database
delete
List roles
get
Create role
post
Retrieve role details
get
Delete role
delete
Retrieve role password
get
Reset role password
post
Endpoint
Create compute endpoint
post
List compute endpoints
get
Retrieve compute endpoint details
get
Delete compute endpoint
delete
Update compute endpoint
patch
Start compute endpoint
post
Suspend compute endpoint
post
Restart compute endpoint
post
Region
List supported regions
get
Users
Retrieve current user details
get
Retrieve current user organizations list
get
Transfer projects from personal account to organization
post
Get request authentication details
get
Consumption
Retrieve account consumption metrics
get
Retrieve project consumption metrics
get
Organizations
Retrieve organization details
get
List organization API keys
get
Create organization API key
post
Revoke organization API key
delete
Retrieve organization members details
get
Retrieve organization member details
get
Update role for organization member
patch
Remove member from the organization
delete
Retrieve organization invitation details
get
Create organization invitations
post
Transfer projects between organizations
post
List VPC endpoints
get
Retrieve VPC endpoint details
get
Assign or update VPC endpoint
post
Delete VPC endpoint
delete
Auth
Create Neon Auth integration
post
List domains in redirect_uri whitelist
get
Add domain to redirect_uri whitelist
post
Delete domain from redirect_uri whitelist
delete
Create Auth Provider SDK keys
post
Create new auth user
post
Transfer Neon-managed auth project to your own account
post
Lists active integrations with auth providers
get
Delete integration with auth provider
delete
List supported regions
get
https://console.neon.tech/api/v2/regions
Lists supported Neon regions
Language
Shell
Credentials
Bearer
RESPONSE
Click
Try It!
to start a request and see the response here!