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
v2.0
API Reference
Use cases
All
Pages
Start typing to 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
API rate limiting
API Key
List API keys
get
Create API key
post
Revoke API key
del
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
del
List project access
get
Grant project access
post
Revoke project access
del
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
del
Retrieve connection URI
get
List VPC endpoint restrictions
get
Set VPC endpoint restriction
post
Delete VPC endpoint restriction
del
Restore a deleted project
post
Recover a deleted project
post
Branch
Create branch
post
List branches
get
Retrieve number of branches
get
Retrieve branch details
get
Delete branch
del
Update branch
patch
Restore branch
post
Retrieve database schema
get
Compare database schema
get
Set branch as default
post
List branch endpoints
get
Finalize restore
post
List databases
get
Create database
post
Retrieve database details
get
Update database
patch
Delete database
del
List roles
get
Create role
post
Retrieve role details
get
Delete role
del
Retrieve role password
get
Reset role password
post
Create anonymized branch
post
Get masking rules
get
Update masking rules
patch
Get anonymized branch status
get
Start anonymization
post
Endpoint
Create compute endpoint
post
List compute endpoints
get
Retrieve compute endpoint details
get
Delete compute endpoint
del
Update compute endpoint
patch
Start compute endpoint
post
Suspend compute endpoint
post
Restart compute endpoint
post
Snapshot
Create snapshot
post
List project snapshots
get
Delete snapshot
del
Update snapshot
patch
Restore snapshot
post
View backup schedule
get
Update backup schedule
put
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
del
Retrieve organization members details
get
Retrieve organization member details
get
Update role for organization member
patch
Remove member from the organization
del
Retrieve organization invitation details
get
Create organization invitations
post
Transfer projects between organizations
post
List VPC endpoints
get
List VPC endpoints across all regions
get
Retrieve VPC endpoint details
get
Assign or update VPC endpoint
post
Delete VPC endpoint
del
Auth
Get details of Neon Auth for the branch
get
Enable Neon Auth for the branch
post
Disables Neon Auth for the branch
del
List domains in redirect_uri whitelist
get
Add domain to redirect_uri whitelist
post
Delete domain from redirect_uri whitelist
del
Create new auth user
post
Delete auth user
del
Update auth user role
put
List OAuth providers for neon auth for a branch
get
Add a OAuth provider
post
Update OAuth provider
patch
Delete OAuth provider
del
Send test email
post
Get email and password configuration
get
Update email and password configuration
patch
Get email provider configuration
get
Update email provider configuration
patch
Get allow localhost
get
Update allow localhost
patch
Auth (legacy)
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
del
Create Auth Provider SDK keys
post
Create new auth user
post
Delete auth user
del
Transfer Neon-managed auth project to your own account
post
Lists active integrations with auth providers
get
List OAuth providers
get
Add a OAuth provider
post
Update OAuth provider
patch
Delete OAuth provider
del
Get email server configuration
get
Update email server configuration
patch
Delete integration with auth provider
del
DataAPI
Create Neon Data API
post
Delete Neon Data API
del
Get Neon Data API
get
Update Neon Data API
patch
Use cases
Ask AI
How you can use the Neon API
