[metadata]
article:modified_time: 2025-09-09T20:09:22.000Z
dateModified: 2025-09-09T20:09:22.000Z
description: This page will help you get started with the Neon API
loadedProject: neon-tech
og:description: This page will help you get started with the Neon API
og:image: https://files.readme.io/062273b00f2f2548249f0f18bd23be0ae4f7ee3e431429f2c5395bf3f709d4f6-index.jpg
og:image:height: 630
og:image:width: 1200
og:site_name: Neon
og:title: Neon API Reference
og:updated_time: 2025-09-09T20:09:22.000Z
readme-deploy: 5.838.2
readme-project-flags: kMbxrMyjFjtW2K2QZXYTSw==:gbRoZp1bnD7UgGqILQ0jWuZ1WirKuXTmXQggvqjzVYXeVjXN7v9JBvVsaQtGEauyo+6Ikuk8qTnph1vZRSbx8ZNfq1BvtTyN96okWDKv1XDirXsnkPmV1UlCywlV3sZc1JCKfvM/lrb5XJ7sjO+huA==
readme-repo: neon-tech-5117089289c2
readme-subdomain: neon-tech
readme-version: 2.0
twitter:card: summary_large_image
twitter:description: This page will help you get started with the Neon API
twitter:image: https://files.readme.io/062273b00f2f2548249f0f18bd23be0ae4f7ee3e431429f2c5395bf3f709d4f6-index.jpg
twitter:title: Neon API Reference
viewport: width=device-width, initial-scale=1.0

[canonical-links]
https://api-docs.neon.tech/reference/getting-started-with-neon-api

[document-links]
AI Gateway: /reference/getprojectbranchaigateway
API Key: /reference/api-key
API Key: /reference/listapikeys
API Reference: /reference
API rate limiting: /reference/api-rate-limiting
Accept a project transfer request: /reference/acceptprojecttransferrequest
Add JWKS URL: /reference/addprojectjwks
Add an OAuth provider: /reference/addbranchneonauthoauthprovider
Add an OAuth provider: /reference/addneonauthoauthprovider
Add domain to redirect_uri whitelist: /reference/addbranchneonauthtrusteddomain
Add trusted redirect URI domain: /reference/addneonauthdomaintoredirecturiwhitelist
Assign or update VPC endpoint: /reference/assignorganizationvpcendpoint
Auth (legacy): /reference/createneonauthintegration
Auth: /reference/getneonauth
Authentication: /reference/authentication
Branch: /reference/createprojectbranch
Buckets: /reference/createprojectbranchbucket
Compare database schema: /reference/getprojectbranchschemacomparison
Consumption: /reference/getconsumptionhistoryperproject
Create API key: /reference/createapikey
Create Auth Provider SDK keys: /reference/createneonauthprovidersdkkeys
Create Neon Auth integration: /reference/createneonauthintegration
Create Neon Data API: /reference/createprojectbranchdataapi
Create a bucket on the branch: /reference/createprojectbranchbucket
Create a project transfer request: /reference/createprojecttransferrequest
Create anonymized branch: /reference/createprojectbranchanonymized
Create branch: /reference/createprojectbranch
Create compute endpoint: /reference/createprojectendpoint
Create database: /reference/createprojectbranchdatabase
Create new auth user: /reference/createbranchneonauthnewuser
Create new auth user: /reference/createneonauthnewuser
Create organization API key: /reference/createorgapikey
Create organization invitations: /reference/createorganizationinvitations
Create project: /reference/createproject
Create role: /reference/createprojectbranchrole
Create snapshot: /reference/createsnapshot
Credentials: /reference/createcredential
DataAPI: /reference/createprojectbranchdataapi
Delete JWKS URL: /reference/deleteprojectjwks
Delete Neon Data API: /reference/deleteprojectbranchdataapi
Delete OAuth provider: /reference/deletebranchneonauthoauthprovider
Delete OAuth provider: /reference/deleteneonauthoauthprovider
Delete VPC endpoint restriction: /reference/deleteprojectvpcendpoint
Delete VPC endpoint: /reference/deleteorganizationvpcendpoint
Delete a bucket on the branch: /reference/deleteprojectbranchbucket
Delete a function on the branch: /reference/deleteprojectbranchfunction
Delete an object in a bucket: /reference/deleteprojectbranchbucketobject
Delete auth user: /reference/deletebranchneonauthuser
Delete auth user: /reference/deleteneonauthuser
Delete branch: /reference/deleteprojectbranch
Delete compute endpoint: /reference/deleteprojectendpoint
Delete database: /reference/deleteprojectbranchdatabase
Delete domain from redirect_uri whitelist: /reference/deletebranchneonauthtrusteddomain
Delete every object under a key prefix (folder) in a bucket: /reference/deleteprojectbranchbucketobjectsbyprefix
Delete integration with auth provider: /reference/deleteneonauthintegration
Delete project: /reference/deleteproject
Delete role: /reference/deleteprojectbranchrole
Delete snapshot: /reference/deletesnapshot
Delete trusted redirect URI domain: /reference/deleteneonauthdomainfromredirecturiwhitelist
Deploy code to a function: /reference/createprojectbranchfunctiondeployment
Disable Neon Auth for the branch: /reference/disableneonauth
Discord Server: https://discord.gg/92vNTzKDGp
Discord: https://discord.com/invite/92vNTzKDGp
Download an object's bytes: /reference/getprojectbranchbucketobject
Enable Neon Auth for the branch: /reference/createneonauth
Endpoint: /reference/createprojectendpoint
Finalize branch restore from snapshot: /reference/finalizerestorebranch
Functions: /reference/listprojectbranchfunctions
Get advisor issues: /reference/getprojectadvisorsecurityissues
Get branch AI Gateway endpoint: /reference/getprojectbranchaigateway
Get branch object storage state: /reference/getprojectbranchstorage
Get function details: /reference/getprojectbranchfunction
Getting Support: https://neon.tech/docs/introduction/support
Grant project access: /reference/grantpermissiontoproject
Issue a scoped credential on the branch: /reference/createcredential
List API keys: /reference/listapikeys
List JWKS URLs: /reference/getprojectjwks
List OAuth providers for the branch: /reference/listbranchneonauthoauthproviders
List OAuth providers: /reference/listneonauthoauthproviders
List VPC endpoint restrictions: /reference/listprojectvpcendpoints
List VPC endpoints across all regions: /reference/listorganizationvpcendpointsallregions
List VPC endpoints: /reference/listorganizationvpcendpoints
List active integrations with auth providers: /reference/listneonauthintegrations
List available shared preload libraries: /reference/getavailablepreloadlibraries
List branch endpoints: /reference/listprojectbranchendpoints
List branch log field values: /reference/listprojectbranchlogfieldvalues
List branch log fields: /reference/listprojectbranchlogfields
List branches: /reference/listprojectbranches
List buckets on the branch: /reference/listprojectbranchbuckets
List compute endpoints: /reference/listprojectendpoints
List credentials on the branch: /reference/listcredentials
List databases: /reference/listprojectbranchdatabases
List domains in redirect_uri whitelist: /reference/listbranchneonauthtrusteddomains
List functions on the branch: /reference/listprojectbranchfunctions
List objects in a bucket: /reference/listprojectbranchbucketobjects
List operations: /reference/listprojectoperations
List org members and their project roles: /reference/listprojectmembers
List organization API keys: /reference/listorgapikeys
List organization invitations: /reference/getorganizationinvitations
List organization members: /reference/getorganizationmembers
List organizations for the current user: /reference/getcurrentuserorganizations
List project access: /reference/listprojectpermissions
List project snapshots: /reference/listsnapshots
List projects: /reference/listprojects
List roles: /reference/listprojectbranchroles
List shared projects: /reference/listsharedprojects
List supported regions: /reference/getactiveregions
List trusted redirect URI domains: /reference/listneonauthredirecturiwhitelistdomains
Logs: /reference/queryprojectbranchlogs
Manage API keys with the Neon API: https://neon.tech/docs/manage/api-keys#manage-api-keys-with-the-neon-api
Manage Organizations using the Neon API: https://neon.tech/docs/manage/orgs-api
Manage branches with the Neon API: https://neon.tech/docs/manage/branches#branching-with-the-neon-api
Manage compute endpoints with the Neon API: https://neon.tech/docs/manage/endpoints#manage-compute-endpoints-with-the-neon-api
Manage databases with the Neon API: https://neon.tech/docs/manage/databases#manage-databases-with-the-neon-api
Manage projects with the Neon API: https://neon.tech/docs/manage/projects#manage-projects-with-the-neon-api
Manage roles with the Neon API: https://neon.tech/docs/manage/roles#manage-roles-with-the-neon-api
Neon API Reference: /reference/getting-started-with-neon-api
Neon API for AI Agents: /reference/ai-agents
Neon Console: https://console.neon.tech/
Neon Docs: https://neon.com/docs/introduction/about
Neon OpenAPI Specification: https://neon.com/api_spec/release/v2.json
Neon OpenAPI specification: https://neon.tech/api_spec/release/v2.json
Operation: /reference/getprojectoperation
Organizations: /reference/getorganization
Overview of the Neon object hierarchy: https://neon.tech/docs/manage/overview
Pagination: /reference/pagination
Path parameters: /reference/path-parameters
Poll operation status: https://neon.tech/docs/manage/operations#poll-operation-status
Presign an upload or download for an object in a bucket: /reference/presignprojectbranchbucketobject
Project: /reference/listprojects
Query branch logs: /reference/queryprojectbranchlogs
Query consumption metrics: https://neon.tech/docs/guides/partner-consumption-metrics
Recover a deleted project: /reference/recoverproject
Region: /reference/getactiveregions
Remove an org member's role on a project: /reference/removeprojectmemberrole
Remove organization member: /reference/removeorganizationmember
Remove organization spending limit: /reference/deleteorganizationspendinglimit
Reset role password: /reference/resetprojectbranchrolepassword
Restart compute endpoint: /reference/restartprojectendpoint
Restore branch to a historical state: /reference/restoreprojectbranch
Restore snapshot: /reference/restoresnapshot
Retrieve Neon Auth details for the branch: /reference/getneonauth
Retrieve Neon Auth plugin configurations: /reference/getneonauthpluginconfigs
Retrieve Neon Auth webhook configuration: /reference/getneonauthwebhookconfig
Retrieve Neon Data API configuration: /reference/getprojectbranchdataapi
Retrieve VPC endpoint details: /reference/getorganizationvpcendpointdetails
Retrieve anonymized branch status: /reference/getanonymizedbranchstatus
Retrieve backup schedule: /reference/getsnapshotschedule
Retrieve branch consumption metrics: /reference/getconsumptionhistoryperbranchv2
Retrieve branch details: /reference/getprojectbranch
Retrieve compute endpoint details: /reference/getprojectendpoint
Retrieve connection URI: /reference/getconnectionuri
Retrieve current user details: /reference/getcurrentuserinfo
Retrieve database details: /reference/getprojectbranchdatabase
Retrieve database schema: /reference/getprojectbranchschema
Retrieve email and password configuration: /reference/getneonauthemailandpasswordconfig
Retrieve email provider configuration: /reference/getneonauthemailprovider
Retrieve email server configuration: /reference/getneonauthemailserver
Retrieve localhost allow setting: /reference/getneonauthallowlocalhost
Retrieve masking rules: /reference/getmaskingrules
Retrieve number of branches: /reference/countprojectbranches
Retrieve operation details: /reference/getprojectoperation
Retrieve organization details: /reference/getorganization
Retrieve organization member details: /reference/getorganizationmember
Retrieve organization spending limit: /reference/getorganizationspendinglimit
Retrieve phone number plugin configuration: /reference/getneonauthphonenumberplugin
Retrieve project consumption metrics (legacy plans): /reference/getconsumptionhistoryperproject
Retrieve project consumption metrics: /reference/getconsumptionhistoryperprojectv2
Retrieve project details: /reference/getproject
Retrieve request authentication details: /reference/getauthdetails
Retrieve role details: /reference/getprojectbranchrole
Retrieve role password: /reference/getprojectbranchrolepassword
Revoke API key: /reference/revokeapikey
Revoke a credential: /reference/revokecredential
Revoke organization API key: /reference/revokeorgapikey
Revoke project access: /reference/revokepermissionfromproject
SDKs and providers for the Neon API: /reference/sdks-for-the-neon-api
Send test email: /reference/sendneonauthtestemail
Set VPC endpoint restriction: /reference/assignprojectvpcendpoint
Set an org member's role on a project: /reference/setprojectmemberrole
Set branch as default: /reference/setdefaultprojectbranch
Set organization spending limit: /reference/setorganizationspendinglimit
Snapshot: /reference/createsnapshot
Start anonymization: /reference/startanonymization
Start compute endpoint: /reference/startprojectendpoint
Storage: /reference/getprojectbranchstorage
Suspend compute endpoint: /reference/suspendprojectendpoint
Transfer Neon-managed auth project to your own account: /reference/transferneonauthproviderproject
Transfer projects between organizations: /reference/transferprojectsfromorgtoorg
Transfer projects from personal account to organization: /reference/transferprojectsfromusertoorg
Update Neon Auth webhook configuration: /reference/updateneonauthwebhookconfig
Update Neon Data API: /reference/updateprojectbranchdataapi
Update OAuth provider: /reference/updatebranchneonauthoauthprovider
Update OAuth provider: /reference/updateneonauthoauthprovider
Update a function: /reference/updateprojectbranchfunction
Update auth user role: /reference/updateneonauthuserrole
Update backup schedule: /reference/setsnapshotschedule
Update branch: /reference/updateprojectbranch
Update compute endpoint: /reference/updateprojectendpoint
Update database: /reference/updateprojectbranchdatabase
Update email and password configuration: /reference/updateneonauthemailandpasswordconfig
Update email provider configuration: /reference/updateneonauthemailprovider
Update email server configuration: /reference/updateneonauthemailserver
Update localhost allow setting: /reference/updateneonauthallowlocalhost
Update magic link plugin configuration: /reference/updateneonauthmagiclinkplugin
Update masking rules: /reference/updatemaskingrules
Update organization plugin configuration: /reference/updateneonauthorganizationplugin
Update phone number plugin configuration: /reference/updateneonauthphonenumberplugin
Update project: /reference/updateproject
Update role for organization member: /reference/updateorganizationmember
Update snapshot: /reference/updatesnapshot
Use cases: /reference/use-cases
Users: /reference/getcurrentuserinfo
View operations with the Neon API: https://neon.tech/docs/manage/operations#view-operations-with-the-neon-api
https://neon.com/

[structured-data]
{"@context":"https://schema.org","@type":"TechArticle","dateModified":"2025-09-09T20:09:22.000Z","headline":"Neon API Reference"}

[content]
Neon API Reference
For AI agents: visit https://api-docs.neon.tech/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.
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
Neon API Reference
JUMP TO
Neon API
Neon API Reference
API Key
List API keys
Create API key
Revoke API key
Operation
Retrieve operation details
List operations
Project
List projects
Create project
List shared projects
Retrieve project details
Update project
Delete project
List project access
Grant project access
Revoke project access
List available shared preload libraries
Create a project transfer request
Accept a project transfer request
List JWKS URLs
Add JWKS URL
Delete JWKS URL
Retrieve connection URI
List VPC endpoint restrictions
Set VPC endpoint restriction
Delete VPC endpoint restriction
Recover a deleted project
Get advisor issues
List org members and their project roles
Set an org member's role on a project
Remove an org member's role on a project
Branch
Create branch
List branches
Retrieve number of branches
Retrieve branch details
Delete branch
Update branch
Restore branch to a historical state
Retrieve database schema
Compare database schema
Set branch as default
List branch endpoints
Finalize branch restore from snapshot
List databases
Create database
Retrieve database details
Update database
Delete database
List roles
Create role
Retrieve role details
Delete role
Retrieve role password
Reset role password
Create anonymized branch
Retrieve masking rules
Update masking rules
Retrieve anonymized branch status
Start anonymization
Endpoint
Create compute endpoint
List compute endpoints
Retrieve compute endpoint details
Delete compute endpoint
Update compute endpoint
Start compute endpoint
Suspend compute endpoint
Restart compute endpoint
Snapshot
Create snapshot
List project snapshots
Delete snapshot
Update snapshot
Restore snapshot
Retrieve backup schedule
Update backup schedule
Region
List supported regions
Users
Retrieve current user details
List organizations for the current user
Transfer projects from personal account to organization
Retrieve request authentication details
Consumption
Retrieve project consumption metrics (legacy plans)
Retrieve project consumption metrics
Retrieve branch consumption metrics
Organizations
Retrieve organization details
List organization API keys
Create organization API key
Revoke organization API key
List organization members
Retrieve organization member details
Update role for organization member
Remove organization member
List organization invitations
Create organization invitations
Transfer projects between organizations
List VPC endpoints
List VPC endpoints across all regions
Retrieve VPC endpoint details
Assign or update VPC endpoint
Delete VPC endpoint
Retrieve organization spending limit
Set organization spending limit
Remove organization spending limit
Use cases
Auth
Retrieve Neon Auth details for the branch
Enable Neon Auth for the branch
Disable Neon Auth for the branch
List domains in redirect_uri whitelist
Add domain to redirect_uri whitelist
Delete domain from redirect_uri whitelist
Create new auth user
Delete auth user
Update auth user role
List OAuth providers for the branch
Add an OAuth provider
Update OAuth provider
Delete OAuth provider
Send test email
Retrieve email and password configuration
Update email and password configuration
Retrieve email provider configuration
Update email provider configuration
Retrieve localhost allow setting
Update localhost allow setting
Retrieve Neon Auth plugin configurations
Update organization plugin configuration
Retrieve Neon Auth webhook configuration
Update Neon Auth webhook configuration
Update magic link plugin configuration
Retrieve phone number plugin configuration
Update phone number plugin configuration
Authentication
Pagination
Path parameters
SDKs and providers for the Neon API
Neon API for AI Agents
API rate limiting
Auth (legacy)
Create Neon Auth integration
List trusted redirect URI domains
Add trusted redirect URI domain
Delete trusted redirect URI domain
Create Auth Provider SDK keys
Create new auth user
Delete auth user
Transfer Neon-managed auth project to your own account
List active integrations with auth providers
List OAuth providers
Add an OAuth provider
Update OAuth provider
Delete OAuth provider
Retrieve email server configuration
Update email server configuration
Delete integration with auth provider
Storage
Get branch object storage state
Buckets
Create a bucket on the branch
List buckets on the branch
Delete a bucket on the branch
List objects in a bucket
Delete an object in a bucket
Download an object's bytes
Delete every object under a key prefix (folder) in a bucket
Presign an upload or download for an object in a bucket
Functions
List functions on the branch
Get function details
Update a function
Delete a function on the branch
Deploy code to a function
AI Gateway
Get branch AI Gateway endpoint
Logs
Query branch logs
List branch log fields
List branch log field values
Credentials
Issue a scoped credential on the branch
List credentials on the branch
Revoke a credential
DataAPI
Create Neon Data API
Delete Neon Data API
Retrieve Neon Data API configuration
Update Neon Data API
Neon API Reference
Copy Page
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.
📘
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 Neon objects, 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
.
Updated
11 months ago
API Key
Did this page help you?
Yes
No
Updated
11 months ago
API Key
Did this page help you?
Yes
No
Introduction
Neon API base URL
Neon OpenAPI Specification
Neon API examples
Need help?
