Skip to main content
N
Neon Postgres Docs
Search documentation
⌘K
Search documentation
Search query
Esc
All
Guides
API
Changelog
Type to search this documentation.
✦
Home
Postgres
Plans & billing
Resilience & architecture
Manage & operate
AI agents on Neon
Integrations & tooling
Get started
Building on Neon
APIs & SDKs
Community
Auth
Neon Functions
Object Storage
AI Gateway
Security & compliance
Concepts
API Reference
Changelog
API reference
Region
Copy page
Copy page
View as Markdown
Open in ChatGPT
Open in Claude
Copy MCP install command
Connect to Cursor
Connect to VS Code
These methods allow you to inspect Neon regions.
GET
List supported regions
/regions
Documentation menu
Getting started
Authentication
API reference
Overview
API Key
Overview
List API keys
GET
Create API key
POST
Revoke API key
DELETE
Operation
Overview
List operations
GET
Retrieve operation details
GET
Project
Overview
List projects
GET
Create project
POST
List shared projects
GET
Delete project
DELETE
Retrieve project details
GET
Update project
PATCH
Get advisor issues
GET
List available shared preload libraries
GET
Retrieve connection URI
GET
List JWKS URLs
GET
Add JWKS URL
POST
Delete JWKS URL
DELETE
List org members and their project roles
GET
Remove an org member's role on a project
DELETE
Set an org member's role on a project
PUT
List project access
GET
Grant project access
POST
Revoke project access
DELETE
Recover a deleted project
POST
Create a project transfer request
POST
Accept a project transfer request
PUT
List VPC endpoint restrictions
GET
Delete VPC endpoint restriction
DELETE
Set VPC endpoint restriction
POST
Branch
Overview
Create anonymized branch
POST
List branches
GET
Create branch
POST
Retrieve number of branches
GET
Delete branch
DELETE
Retrieve branch details
GET
Update branch
PATCH
Start anonymization
POST
Retrieve anonymized branch status
GET
Compare database schema
GET
List databases
GET
Create database
POST
Delete database
DELETE
Retrieve database details
GET
Update database
PATCH
List branch endpoints
GET
Finalize branch restore from snapshot
POST
Retrieve masking rules
GET
Update masking rules
PATCH
Restore branch to a historical state
POST
List roles
GET
Create role
POST
Delete role
DELETE
Retrieve role details
GET
Reset role password
POST
Retrieve role password
GET
Retrieve database schema
GET
Set branch as default
POST
Endpoint
Overview
List compute endpoints
GET
Create compute endpoint
POST
Delete compute endpoint
DELETE
Retrieve compute endpoint details
GET
Update compute endpoint
PATCH
Restart compute endpoint
POST
Start compute endpoint
POST
Suspend compute endpoint
POST
Snapshot
Overview
Retrieve backup schedule
GET
Update backup schedule
PUT
Create snapshot
POST
List project snapshots
GET
Delete snapshot
DELETE
Update snapshot
PATCH
Restore snapshot
POST
Region
Overview
List supported regions
GET
Users
Overview
Retrieve request authentication details
GET
Retrieve current user details
GET
List organizations for the current user
GET
Transfer projects from personal account to organization
POST
Consumption
Overview
Retrieve project consumption metrics (legacy plans)
GET
Retrieve branch consumption metrics
GET
Retrieve project consumption metrics
GET
Organizations
Overview
Retrieve organization details
GET
List organization API keys
GET
Create organization API key
POST
Revoke organization API key
DELETE
Remove organization spending limit
DELETE
Retrieve organization spending limit
GET
Set organization spending limit
PUT
List organization invitations
GET
Create organization invitations
POST
List organization members
GET
Remove organization member
DELETE
Retrieve organization member details
GET
Update role for organization member
PATCH
List VPC endpoints
GET
Delete VPC endpoint
DELETE
Retrieve VPC endpoint details
GET
Assign or update VPC endpoint
POST
List VPC endpoints across all regions
GET
Transfer projects between organizations
POST
Auth
Overview
Disable Neon Auth for the branch
DELETE
Retrieve Neon Auth details for the branch
GET
Enable Neon Auth for the branch
POST
Retrieve localhost allow setting
GET
Update localhost allow setting
PATCH
Delete domain from redirect_uri whitelist
DELETE
List domains in redirect_uri whitelist
GET
Add domain to redirect_uri whitelist
POST
Retrieve email and password configuration
GET
Update email and password configuration
PATCH
Retrieve email provider configuration
GET
Update email provider configuration
PATCH
Send test email using the saved email provider
POST
List OAuth providers for the branch
GET
Add an OAuth provider
POST
Delete OAuth provider
DELETE
Update OAuth provider
PATCH
Retrieve Neon Auth plugin configurations
GET
Update magic link plugin configuration
PATCH
Update organization plugin configuration
PATCH
Retrieve phone number plugin configuration
GET
Update phone number plugin configuration
PATCH
Send test email
POST
Create new auth user
POST
Delete auth user
DELETE
Update auth user role
PUT
Retrieve Neon Auth webhook configuration
GET
Update Neon Auth webhook configuration
PUT
Auth (legacy)
Overview
Create Neon Auth integration
POST
Create Auth Provider SDK keys
POST
Transfer Neon-managed auth project to your own account
POST
Create new auth user
POST
Delete trusted redirect URI domain
DELETE
List trusted redirect URI domains
GET
Add trusted redirect URI domain
POST
Retrieve email server configuration
GET
Update email server configuration
PATCH
Delete integration with auth provider
DELETE
List active integrations with auth providers
GET
List OAuth providers
GET
Add an OAuth provider
POST
Delete OAuth provider
DELETE
Update OAuth provider
PATCH
Delete auth user
DELETE
Storage
Overview
Get branch object storage state
GET
Buckets
Overview
List buckets on the branch
GET
Create a bucket on the branch
POST
Delete a bucket on the branch
DELETE
List objects in a bucket
GET
Delete every object under a key prefix (folder) in a bucket
DELETE
Delete an object in a bucket
DELETE
Download an object's bytes
GET
Presign an upload or download for an object in a bucket
POST
Functions
Overview
List the custom domains on a branch
GET
Register a custom domain on a branch
POST
Delete a custom domain from a branch
DELETE
List functions on the branch
GET
Delete a function on the branch
DELETE
Get function details
GET
Update a function
PATCH
Deploy code to a function
POST
List triggers on the branch
GET
Create a trigger
POST
Delete a trigger
DELETE
Get a trigger
GET
Update a trigger
PATCH
AI Gateway
Overview
Get branch AI Gateway endpoint
GET
Logs
Overview
List branch log fields
GET
List branch log field values
GET
Query branch logs
POST
Credentials
Overview
List credentials on the branch
GET
Issue a scoped credential on the branch
POST
Revoke a credential
DELETE
Reveal a credential's secrets
POST
Rotate a credential's secrets
POST
DataAPI
Overview
Delete Neon Data API
DELETE
Retrieve Neon Data API configuration
GET
Update Neon Data API
PATCH
Create Neon Data API
POST