Neon

Revoke API key. Revokes the specified API key. An API key that is no longer needed can be revoked. This action cannot be reversed. API keys can also be managed in the Neon Console. See Manage API keys. DELETE /api_keys/{key_id}

Revoke organization API key. Revokes the specified organization API key. An API key that is no longer needed can be revoked. This action cannot be reversed. API keys can also be managed in the Neon Console. See Manage API keys. DELETE /organizations/{org_id}/api_keys/{key_id}

Remove organization spending limit. Removes the configured monthly spending limit for the specified organization. Idempotent — removing an already-unset limit still succeeds. DELETE /organizations/{org_id}/billing/spending_limit

Remove organization member. Removes the specified member from the organization. Only organization admins can perform this action. The last admin in an organization cannot be removed. DELETE /organizations/{org_id}/members/{member_id}

Delete VPC endpoint. Deletes the VPC endpoint from the specified Neon organization. If you delete a VPC endpoint from a Neon organization, that VPC endpoint cannot be added back to the Neon organization. DELETE /organizations/{org_id}/vpc/region/{region_id}/vpc_endpoints/{vpc_endpoint_id}

Delete project. Deletes the specified project and all its endpoints, branches, databases, and users. Deleted projects can be recovered within 7 days using `POST /projects/{project_id}/recover`. DELETE /projects/{project_id}

Delete trusted redirect URI domain. Deprecated. Use `/projects/{project_id}/branches/{branch_id}/auth/domains` instead. Removal scheduled for March 1, 2026. DELETE /projects/{project_id}/auth/domains

Delete integration with auth provider. Deprecated. Use `/projects/{project_id}/branches/{branch_id}/auth` instead. Removal scheduled for March 1, 2026. DELETE /projects/{project_id}/auth/integration/{auth_provider}

Delete OAuth provider. Deprecated. Use `/projects/{project_id}/branches/{branch_id}/auth/oauth_providers/{oauth_provider_id}` instead. Removal scheduled for March 1, 2026. DELETE /projects/{project_id}/auth/oauth_providers/{oauth_provider_id}

Delete auth user. Deprecated. Use `/projects/{project_id}/branches/{branch_id}/auth/users/{auth_user_id}` instead. Removal scheduled for March 1, 2026. DELETE /projects/{project_id}/auth/users/{auth_user_id}

Delete branch. Deletes the specified branch from a project and places all compute endpoints into an idle state, breaking existing client connections. The deletion completes after all operations finish. DELETE /projects/{project_id}/branches/{branch_id}

Disable Neon Auth for the branch. Disables the Neon Auth integration for the specified branch, removing the connection to the authentication provider. DELETE /projects/{project_id}/branches/{branch_id}/auth

Delete domain from redirect_uri whitelist. Removes a domain from the redirect URI whitelist for the specified branch. After removal, the domain can no longer be used as a redirect target after authentication. DELETE /projects/{project_id}/branches/{branch_id}/auth/domains

Delete OAuth provider. Deletes an OAuth provider from the specified project. DELETE /projects/{project_id}/branches/{branch_id}/auth/oauth_providers/{oauth_provider_id}

Delete auth user. Deletes the specified user from the Neon Auth user directory for the specified branch. Removes the user record from `neon_auth.users_sync`. This action cannot be undone. DELETE /projects/{project_id}/branches/{branch_id}/auth/users/{auth_user_id}

Delete a bucket on the branch. Deletes the named bucket from the specified branch. **Note**: This endpoint is currently in Beta. DELETE /projects/{project_id}/branches/{branch_id}/buckets/{bucket_name}

Delete an object in a bucket. Deletes the named object from the bucket on the specified branch. Served by the user's session (no customer S3 credentials required). **Note**: This endpoint is currently in Beta. DELETE /projects/{project_id}/branches/{branch_id}/buckets/{bucket_name}/objects/{object_key}

Delete every object under a key prefix (folder) in a bucket. Soft-deletes every object on the specified branch whose key starts with `prefix`, in a single call. DELETE /projects/{project_id}/branches/{branch_id}/buckets/{bucket_name}/objects-by-prefix

Revoke a credential. Soft-deletes the credential. Idempotent. **Note**: This endpoint is currently in Beta. DELETE /projects/{project_id}/branches/{branch_id}/credentials/{token_id}

Delete a custom domain from a branch. Removes a custom domain registered on the branch and stops routing it. **Note**: This endpoint is currently in Beta. DELETE /projects/{project_id}/branches/{branch_id}/custom-domains/{domain}

Delete Neon Data API. Deletes the Neon Data API for the specified branch. Existing connections using the Data API endpoint will fail after deletion. DELETE /projects/{project_id}/branches/{branch_id}/data-api/{database_name}

Delete database. Deletes the specified database from the branch. DELETE /projects/{project_id}/branches/{branch_id}/databases/{database_name}

Delete a function on the branch. Deletes the function identified by its slug. **Note**: This endpoint is currently in Beta. DELETE /projects/{project_id}/branches/{branch_id}/functions/{slug}

Delete role. Deletes the specified Postgres role from the branch. DELETE /projects/{project_id}/branches/{branch_id}/roles/{role_name}

Delete compute endpoint. Deletes the specified compute endpoint. A compute endpoint is a Neon compute instance. Deleting a compute endpoint drops existing network connections to the compute endpoint. DELETE /projects/{project_id}/endpoints/{endpoint_id}

Delete JWKS URL. Removes the specified JWKS URL from the project. JWTs signed by keys from the removed URL can no longer authenticate to the project's endpoints. DELETE /projects/{project_id}/jwks/{jwks_id}

Remove an org member's role on a project. Idempotently removes the explicit project grant. The member's organization-role default project permission still applies. DELETE /projects/{project_id}/members/{member_id}/role

Revoke project access. Revokes project access from the user associated with the specified permission `id`. You can retrieve a user's permission `id` by listing project access. DELETE /projects/{project_id}/permissions/{permission_id}

Delete snapshot. Deletes the specified snapshot. DELETE /projects/{project_id}/snapshots/{snapshot_id}

Delete VPC endpoint restriction. Removes the specified VPC endpoint restriction from a Neon project. DELETE /projects/{project_id}/vpc_endpoints/{vpc_endpoint_id}

List API keys. Retrieves the API keys for your Neon account. The response does not include API key tokens. A token is only provided when creating an API key. API keys can also be managed in the Neon Console. GET /api_keys

Retrieve request authentication details. Returns authentication details for the credentials used in the request, including the credential type (API key, Bearer token, or OAuth session) and the associated identity. GET /auth

Retrieve project consumption metrics (legacy plans). Retrieves consumption metrics for Scale, Business, and Enterprise plan projects. History begins at the time of upgrade. Results are ordered by time in ascending order (oldest to newest). GET /consumption_history/projects

Retrieve branch consumption metrics. Returns consumption metrics for each branch across one or more projects listed in `project_ids` (1 to 100 projects). GET /consumption_history/v2/branches

Retrieve project consumption metrics. Returns consumption metrics for up to `limit` projects per page. If `project_ids` is omitted, projects in the organization are included across pages (use `cursor`). GET /consumption_history/v2/projects

Retrieve organization details. Retrieves details for the specified organization, including its name, plan, and configuration. GET /organizations/{org_id}

List organization API keys. Retrieves the API keys for the specified organization. The response does not include API key tokens. A token is only provided when creating an API key. GET /organizations/{org_id}/api_keys

Retrieve organization spending limit. Returns the configured monthly spending limit for the specified organization. `spending_limit_cents: null` indicates that no limit is currently set. GET /organizations/{org_id}/billing/spending_limit

List organization invitations. Retrieves pending and accepted invitations for the specified organization. GET /organizations/{org_id}/invitations

List organization members. Retrieves a paginated list of members for the specified organization. GET /organizations/{org_id}/members

Retrieve organization member details. Retrieves information about the specified organization member. GET /organizations/{org_id}/members/{member_id}

List VPC endpoints. Retrieves the list of VPC endpoints for the specified Neon organization. GET /organizations/{org_id}/vpc/region/{region_id}/vpc_endpoints

Retrieve VPC endpoint details. Retrieves the current state and configuration details of a specified VPC endpoint. GET /organizations/{org_id}/vpc/region/{region_id}/vpc_endpoints/{vpc_endpoint_id}

List VPC endpoints across all regions. Retrieves the list of VPC endpoints for the specified Neon organization across all regions. GET /organizations/{org_id}/vpc/vpc_endpoints

List projects. Retrieves a list of projects for the specified organization. If using a personal API key, include the `org_id` parameter to specify which organization to work with. GET /projects

Retrieve project details. Retrieves information about the specified project. Returned details include the project settings, compute configuration, history retention, owner information, and current usage metrics. GET /projects/{project_id}

Get advisor issues. Analyzes the database for security and performance issues. Returns a list of issues categorized by severity (ERROR, WARN, INFO). Requires read access to the project and Data API enabled. GET /projects/{project_id}/advisors

List trusted redirect URI domains. Deprecated. Use `/projects/{project_id}/branches/{branch_id}/auth/domains` instead. Removal scheduled for March 1, 2026. GET /projects/{project_id}/auth/domains

Retrieve email server configuration. Deprecated. Use `/projects/{project_id}/branches/{branch_id}/auth/email_provider` instead. Removal scheduled for March 1, 2026. GET /projects/{project_id}/auth/email_server

List active integrations with auth providers. Deprecated. Use `/projects/{project_id}/branches/{branch_id}/auth` instead. Removal scheduled for March 1, 2026. GET /projects/{project_id}/auth/integrations

List OAuth providers. Deprecated. Use `/projects/{project_id}/branches/{branch_id}/auth/oauth_providers` instead. Removal scheduled for March 1, 2026. GET /projects/{project_id}/auth/oauth_providers

List available shared preload libraries. Returns the shared preload libraries available for the specified project's Postgres version. GET /projects/{project_id}/available_preload_libraries

List branches. Retrieves a list of branches for the specified project. Each Neon project has a root branch named `main`. A `branch_id` value has a `br-` prefix. GET /projects/{project_id}/branches

Retrieve branch details. Retrieves information about the specified branch. A `branch_id` value has a `br-` prefix. Each Neon project is initially created with a root and default branch named `main`. GET /projects/{project_id}/branches/{branch_id}

Get branch AI Gateway endpoint. Returns the AI Gateway endpoint host for the specified branch, used to render code-snippet base URLs. A 200 response means the branch is registered and this region serves the AI gateway. GET /projects/{project_id}/branches/{branch_id}/ai_gateway

Retrieve anonymized branch status. Retrieves the current status of an anonymized branch, including its state and progress information. GET /projects/{project_id}/branches/{branch_id}/anonymized_status

Retrieve Neon Auth details for the branch. Retrieves the Neon Auth integration details for the specified branch, including the auth provider type and integration status. GET /projects/{project_id}/branches/{branch_id}/auth

Retrieve localhost allow setting. Retrieves the localhost allow setting for the specified branch's Neon Auth integration. When enabled, authentication flows work from `localhost` without adding it to the redirect URI whitelist. GET /projects/{project_id}/branches/{branch_id}/auth/allow_localhost

List domains in redirect_uri whitelist. Lists the trusted domains in the redirect URI whitelist for the specified branch. Only domains in this list are permitted as redirect targets after authentication. GET /projects/{project_id}/branches/{branch_id}/auth/domains

Retrieve email and password configuration. Retrieves the email and password authentication configuration for the specified branch's Neon Auth integration, including whether it is enabled and the email verification method. GET /projects/{project_id}/branches/{branch_id}/auth/email_and_password

Retrieve email provider configuration. Retrieves the email provider configuration for the specified branch's Neon Auth integration, including the provider type and server settings. GET /projects/{project_id}/branches/{branch_id}/auth/email_provider

List OAuth providers for the branch. Lists the OAuth providers configured for the specified branch's Neon Auth integration. GET /projects/{project_id}/branches/{branch_id}/auth/oauth_providers

Retrieve Neon Auth plugin configurations. Returns all plugin configurations for Neon Auth in a single response. This endpoint aggregates organization, email provider, email and password, OAuth providers, and localhost settings. GET /projects/{project_id}/branches/{branch_id}/auth/plugins

Retrieve phone number plugin configuration. Returns the phone number plugin configuration for Neon Auth. The phone number plugin enables phone-based OTP authentication. GET /projects/{project_id}/branches/{branch_id}/auth/plugins/phone-number

Retrieve Neon Auth webhook configuration. Returns the webhook configuration for the specified branch's Neon Auth integration, including the endpoint URL and the events that trigger it. GET /projects/{project_id}/branches/{branch_id}/auth/webhooks

Retrieve backup schedule. Returns the backup schedule for the specified branch, including the configured snapshot frequencies. GET /projects/{project_id}/branches/{branch_id}/backup_schedule

List buckets on the branch. Lists branchable object storage buckets visible on the specified branch, including those inherited from ancestor branches. **Note**: This endpoint is currently in Beta. GET /projects/{project_id}/branches/{branch_id}/buckets

List objects in a bucket. Lists objects visible in the named bucket on the specified branch, including those inherited from ancestor branches. Listing is served by the user's session (no customer S3 credentials required). GET /projects/{project_id}/branches/{branch_id}/buckets/{bucket_name}/objects

Compare database schema. Compares the schema from the specified database with another branch's schema. GET /projects/{project_id}/branches/{branch_id}/compare_schema

List credentials on the branch. Returns metadata for customer-issued credentials on the branch. Secrets are never included. **Note**: This endpoint is currently in Beta. GET /projects/{project_id}/branches/{branch_id}/credentials

List the custom domains on a branch. Lists all custom domains registered on the branch, across every target entity. **Note**: This endpoint is currently in Beta. GET /projects/{project_id}/branches/{branch_id}/custom-domains

Retrieve Neon Data API configuration. Retrieves the Neon Data API configuration for the specified branch, including endpoint URL, enabled state, and database settings. GET /projects/{project_id}/branches/{branch_id}/data-api/{database_name}

List databases. Retrieves a list of databases for the specified branch. A branch can have multiple databases. GET /projects/{project_id}/branches/{branch_id}/databases

Retrieve database details. Retrieves information about the specified database. GET /projects/{project_id}/branches/{branch_id}/databases/{database_name}

List branch endpoints. Retrieves a list of compute endpoints for the specified branch. Neon permits only one read-write compute endpoint per branch. A branch can have multiple read-only compute endpoints. GET /projects/{project_id}/branches/{branch_id}/endpoints

List functions on the branch. Lists functions on the specified branch. **Note**: This endpoint is currently in Beta. GET /projects/{project_id}/branches/{branch_id}/functions

Get function details. Returns the function identified by its slug. **Note**: This endpoint is currently in Beta. GET /projects/{project_id}/branches/{branch_id}/functions/{slug}

List branch log fields. Lists the low-cardinality log fields observed on this branch whose distinct values can be discovered with the log field-values endpoint. GET /projects/{project_id}/branches/{branch_id}/logs/fields

List branch log field values. Lists the distinct values observed for a low-cardinality log field in the requested time range. GET /projects/{project_id}/branches/{branch_id}/logs/fields/{field_name}/values

Retrieve masking rules. Retrieves the masking rules for the specified anonymized branch. Masking rules define how sensitive data should be anonymized using PostgreSQL Anonymizer. **Note**: This endpoint is currently in Beta. GET /projects/{project_id}/branches/{branch_id}/masking_rules

List roles. Retrieves a list of Postgres roles from the specified branch. GET /projects/{project_id}/branches/{branch_id}/roles

Retrieve role details. Retrieves details about the specified role. In Neon, the terms "role" and "user" are synonymous. GET /projects/{project_id}/branches/{branch_id}/roles/{role_name}

Retrieve role password. Retrieves the password for the specified Postgres role, if possible. GET /projects/{project_id}/branches/{branch_id}/roles/{role_name}/reveal_password

Retrieve database schema. Retrieves the database schema. Specify `lsn` or `timestamp` (not both) to read at a point in time; omit both to read from the database's head. GET /projects/{project_id}/branches/{branch_id}/schema

Get branch object storage state. Returns whether branchable object storage is usable for the specified branch. GET /projects/{project_id}/branches/{branch_id}/storage

Retrieve number of branches. Retrieves the total number of branches in the specified project. Supports an optional `search` parameter to count branches matching a name filter. GET /projects/{project_id}/branches/count

Retrieve connection URI. Retrieves a connection URI for the specified database. The URI uses the standard PostgreSQL connection string format. Set `pooled=true` to include the `-pooler` suffix for a connection pooler URI. GET /projects/{project_id}/connection_uri

List compute endpoints. Retrieves a list of compute endpoints for the specified project. A compute endpoint is a Neon compute instance. GET /projects/{project_id}/endpoints

Retrieve compute endpoint details. Retrieves information about the specified compute endpoint. A compute endpoint is a Neon compute instance. An `endpoint_id` has an `ep-` prefix. GET /projects/{project_id}/endpoints/{endpoint_id}

List JWKS URLs. Returns the JWKS URLs available for verifying JWTs used as the authentication mechanism for the specified project. GET /projects/{project_id}/jwks

List org members and their project roles. Lists organization members and their per-project roles for an org-owned project. Returns 404 when the project is not org-owned, per-project role management is disabled, or the caller has no access. GET /projects/{project_id}/members

List operations. Retrieves a list of operations for the specified Neon project. The number of operations returned can be large. To paginate the response, issue an initial request with a `limit` value. GET /projects/{project_id}/operations

Retrieve operation details. Retrieves details for the specified operation. An operation is an action performed on a Neon project resource. GET /projects/{project_id}/operations/{operation_id}

List project access. Retrieves details about users who have access to the project, including the permission `id`, the granted-to email address, and the date project access was granted. GET /projects/{project_id}/permissions

List project snapshots. Lists the snapshots for the specified project. Each snapshot represents a point-in-time backup of the project data. GET /projects/{project_id}/snapshots

List VPC endpoint restrictions. Lists VPC endpoint restrictions for the specified Neon project. GET /projects/{project_id}/vpc_endpoints

List shared projects. Retrieves a list of projects shared with your Neon account. GET /projects/shared

List supported regions. Lists supported Neon regions. **Note:** Not all regions are available to all organizations. Pass the `org_id` parameter to get an accurate list of regions available to your organization. GET /regions

Retrieve current user details. Retrieves information about the currently authenticated Neon user, including account identifiers, plan details, and linked auth accounts. GET /users/me

List organizations for the current user. Retrieves the organizations that the currently authenticated user belongs to. GET /users/me/organizations

Update role for organization member. Updates the role of an existing member in the specified organization. The requested role must be valid for the organization. Only organization admins can call this endpoint. PATCH /organizations/{org_id}/members/{member_id}

Update project. Updates the specified project. Configurable properties include the project name, default compute settings, history retention period, and IP allowlist. PATCH /projects/{project_id}

Update email server configuration. Deprecated. Use `/projects/{project_id}/branches/{branch_id}/auth/email_provider` instead. Removal scheduled for March 1, 2026. PATCH /projects/{project_id}/auth/email_server

Update OAuth provider. Deprecated. Use `/projects/{project_id}/branches/{branch_id}/auth/oauth_providers/{oauth_provider_id}` instead. Removal scheduled for March 1, 2026. PATCH /projects/{project_id}/auth/oauth_providers/{oauth_provider_id}

Update branch. Updates the specified branch. PATCH /projects/{project_id}/branches/{branch_id}

Update localhost allow setting. Updates the localhost allow setting for the specified branch's Neon Auth integration. When enabled, authentication flows work from `localhost` without adding it to the redirect URI whitelist. PATCH /projects/{project_id}/branches/{branch_id}/auth/allow_localhost

Update auth configuration. Updates the auth configuration for the branch. Currently supports updating the application name used in auth emails. PATCH /projects/{project_id}/branches/{branch_id}/auth/config

Update email and password configuration. Updates the email and password authentication configuration for the specified branch's Neon Auth integration. Only the fields provided in the request body are updated. PATCH /projects/{project_id}/branches/{branch_id}/auth/email_and_password

Update email provider configuration. Updates the email provider configuration for the specified branch's Neon Auth integration. The email provider handles transactional messages such as verification emails and password reset links. PATCH /projects/{project_id}/branches/{branch_id}/auth/email_provider

Update OAuth provider. Updates an OAuth provider for the specified project. PATCH /projects/{project_id}/branches/{branch_id}/auth/oauth_providers/{oauth_provider_id}

Update magic link plugin configuration. Updates the magic link plugin configuration for Neon Auth. The magic link plugin enables passwordless authentication via email magic links. PATCH /projects/{project_id}/branches/{branch_id}/auth/plugins/magic-link

Update organization plugin configuration. Updates the organization plugin configuration for Neon Auth. The organization plugin enables multi-tenant organization support. PATCH /projects/{project_id}/branches/{branch_id}/auth/plugins/organization

Update phone number plugin configuration. Updates the phone number plugin configuration for Neon Auth. Only the fields provided in the request body are updated; omitted fields retain their current values. PATCH /projects/{project_id}/branches/{branch_id}/auth/plugins/phone-number

Update Neon Data API. Updates the Neon Data API configuration for the specified branch. You can optionally provide settings to update the Data API configuration. PATCH /projects/{project_id}/branches/{branch_id}/data-api/{database_name}

Update database. Updates the specified database in the branch. PATCH /projects/{project_id}/branches/{branch_id}/databases/{database_name}

Update a function. Updates the function's mutable metadata — currently only the display `name`. A string sets the display name; `null` clears it, after which the function's `name` falls back to its slug. PATCH /projects/{project_id}/branches/{branch_id}/functions/{slug}

Update masking rules. Updates the masking rules for the specified anonymized branch. Masking rules define how sensitive data should be anonymized using PostgreSQL Anonymizer. **Note**: This endpoint is currently in Beta. PATCH /projects/{project_id}/branches/{branch_id}/masking_rules

Update compute endpoint. Updates the specified compute endpoint. An `endpoint_id` has an `ep-` prefix. A `branch_id` has a `br-` prefix. PATCH /projects/{project_id}/endpoints/{endpoint_id}

Update snapshot. Updates the specified snapshot. PATCH /projects/{project_id}/snapshots/{snapshot_id}

Create API key. Creates an API key. The `key_name` is a user-specified name for the key. Returns an `id` and `key`; the `key` is a randomly generated, 64-bit token required to access the Neon API. POST /api_keys

Create organization API key. Creates an API key for the specified organization. The `key_name` is a user-specified name for the key. POST /organizations/{org_id}/api_keys

Create organization invitations. Creates invitations for a specific organization. If the invited user has an existing account, they automatically join as a member. POST /organizations/{org_id}/invitations

Assign or update VPC endpoint. Assigns a VPC endpoint to a Neon organization or updates its existing assignment. POST /organizations/{org_id}/vpc/region/{region_id}/vpc_endpoints/{vpc_endpoint_id}

Transfer projects between organizations. Transfers selected projects, identified by their IDs, from your organization to another specified organization. POST /organizations/{source_org_id}/projects/transfer

Create project. Creates a Neon project within an organization. If using a personal API key, include the `org_id` parameter to specify which organization to create the project in. POST /projects

Create Neon Auth integration. Deprecated. Use `/projects/{project_id}/branches/{branch_id}/auth` instead. Removal scheduled for March 1, 2026. Use this endpoint if the frontend integration flow can't be used. POST /projects/auth/create

Create Auth Provider SDK keys. Generates SDK or API Keys for the auth provider. POST /projects/auth/keys

Transfer Neon-managed auth project to your own account. Transfers ownership of your Neon-managed auth project to your own auth provider account. POST /projects/auth/transfer_ownership

Create new auth user. Deprecated. Use `/projects/{project_id}/branches/{branch_id}/auth/users` instead. Removal scheduled for March 1, 2026. POST /projects/auth/user

Add trusted redirect URI domain. Deprecated. Use `/projects/{project_id}/branches/{branch_id}/auth/domains` instead. Removal scheduled for March 1, 2026. POST /projects/{project_id}/auth/domains

Add an OAuth provider. Deprecated. Use `/projects/{project_id}/branches/{branch_id}/auth/oauth_providers` instead. Removal scheduled for March 1, 2026. POST /projects/{project_id}/auth/oauth_providers

Create anonymized branch. Creates a new branch with anonymized data using PostgreSQL Anonymizer for static masking. This allows developers to work with masked production data. POST /projects/{project_id}/branch_anonymized

Create branch. Creates a branch in the specified project. No request body is required, but you can specify one to create a compute endpoint or select a non-default parent branch. POST /projects/{project_id}/branches

Start anonymization. Starts the anonymization process for an anonymized branch that is in the initialized, error, or anonymized state. POST /projects/{project_id}/branches/{branch_id}/anonymize

Enable Neon Auth for the branch. Enables Neon Auth for the specified branch by connecting it to an authentication provider. POST /projects/{project_id}/branches/{branch_id}/auth

Add domain to redirect_uri whitelist. Adds a domain to the redirect URI whitelist for the specified branch. Only domains in this list are permitted as redirect targets after authentication. POST /projects/{project_id}/branches/{branch_id}/auth/domains

Send test email using the saved email provider. Sends a test email using the branch's already-saved custom SMTP configuration. POST /projects/{project_id}/branches/{branch_id}/auth/email_provider/test

Add an OAuth provider. Adds an OAuth provider configuration to the specified branch's Neon Auth integration. After adding, users can authenticate using the configured provider. POST /projects/{project_id}/branches/{branch_id}/auth/oauth_providers

Send test email. Sends a test email using the SMTP server settings supplied in the request body to verify connectivity and credentials. Deprecated: to test a branch's already-saved configuration, use `sendNeonAuthEmailProviderTest`, which reuses the stored SMTP password server-side so the caller never has to re-supply (or be able to read) it. POST /projects/{project_id}/branches/{branch_id}/auth/send_test_email

Create new auth user. Creates a new user in the Neon Auth user directory for the specified branch. POST /projects/{project_id}/branches/{branch_id}/auth/users

Create a bucket on the branch. Creates a new branchable object storage bucket on the specified branch. Buckets are managed by the Neon Platform branchable object storage service. **Note**: This endpoint is currently in Beta. POST /projects/{project_id}/branches/{branch_id}/buckets

Presign an upload or download for an object in a bucket. Returns a presigned URL that transfers bytes directly to or from the object's bucket on the specified branch, without the caller ever handling S3 credentials. POST /projects/{project_id}/branches/{branch_id}/buckets/{bucket_name}/objects/{object_key}/presign

Issue a scoped credential on the branch. Issues a new scoped service credential anchored to the specified branch. The response carries `api_token` and `s3_secret_access_key` exactly once — they are not stored server-side. POST /projects/{project_id}/branches/{branch_id}/credentials

Reveal a credential's secrets. Returns the live `api_token` and `s3_secret_access_key` of an existing credential, so a credential whose issuance response was lost can be recovered without minting a new one. POST /projects/{project_id}/branches/{branch_id}/credentials/{token_id}/reveal

Rotate a credential's secrets. Replaces the secret material on an existing scoped credential in place. POST /projects/{project_id}/branches/{branch_id}/credentials/{token_id}/rotate

Register a custom domain on a branch. Registers a customer-owned domain (for example `dashboard.acme.com`) on the branch and points it at a target entity, chosen by `entity_type` + `entity_id`. POST /projects/{project_id}/branches/{branch_id}/custom-domains

Create Neon Data API. Creates a new instance of Neon Data API in the specified branch. The Data API exposes a REST interface over the branch database. POST /projects/{project_id}/branches/{branch_id}/data-api/{database_name}

Create database. Creates a database in the specified branch. A branch can have multiple databases. POST /projects/{project_id}/branches/{branch_id}/databases

Finalize branch restore from snapshot. Finalize the restore operation for a branch created from a snapshot. This operation updates the branch so it functions as the original branch it replaced. POST /projects/{project_id}/branches/{branch_id}/finalize_restore

Query branch logs. Returns logs emitted by services running on the specified branch, ordered by timestamp according to `sort_order`. POST /projects/{project_id}/branches/{branch_id}/logs/query

Restore branch to a historical state. Restores a branch to an earlier state in its own or another branch's history by specifying an LSN or timestamp. Creates a new branch from the historical state. POST /projects/{project_id}/branches/{branch_id}/restore

Create role. Creates a Postgres role in the specified branch. Connections established to the active compute endpoint will be dropped. POST /projects/{project_id}/branches/{branch_id}/roles

Reset role password. Resets the password for the specified Postgres role. Returns a new password and operations. The new password is ready to use when the last operation finishes. POST /projects/{project_id}/branches/{branch_id}/roles/{role_name}/reset_password

Set branch as default. Sets the specified branch as the project's default branch. The default designation is automatically removed from the previous default branch. POST /projects/{project_id}/branches/{branch_id}/set_as_default

Create snapshot. Creates a snapshot from the specified branch. This operation may initiate an asynchronous process. POST /projects/{project_id}/branches/{branch_id}/snapshot

Create compute endpoint. Creates a compute endpoint for the specified branch. A compute endpoint is a Neon compute instance. There is a maximum of one read-write compute endpoint per branch. POST /projects/{project_id}/endpoints

Restart compute endpoint. Restarts the specified compute endpoint by immediately suspending it and then starting it again. An `endpoint_id` has an `ep-` prefix. POST /projects/{project_id}/endpoints/{endpoint_id}/restart

Start compute endpoint. Starts a compute endpoint. The compute endpoint is ready to use after the last operation in the chain finishes successfully. An `endpoint_id` has an `ep-` prefix. POST /projects/{project_id}/endpoints/{endpoint_id}/start

Suspend compute endpoint. Suspends the specified compute endpoint. An `endpoint_id` has an `ep-` prefix. POST /projects/{project_id}/endpoints/{endpoint_id}/suspend

Add JWKS URL. Adds a JWKS URL to the specified project for verifying JWTs used as the authentication mechanism. The URL must be a valid HTTPS URL that returns a JSON Web Key Set. POST /projects/{project_id}/jwks

Grant project access. Grants project access to the account associated with the specified email address. POST /projects/{project_id}/permissions

Recover a deleted project. Recovers a deleted project within the 7-day deletion recovery period. Restores branches, endpoints, settings, and connection strings. Some integrations require manual reconfiguration after recovery. POST /projects/{project_id}/recover

Restore snapshot. Restores the specified snapshot to a new branch, and optionally finalizes the restore operation to replace the original branch. POST /projects/{project_id}/snapshots/{snapshot_id}/restore

Create a project transfer request. Creates a transfer request for the specified project. The request expires after a set period. POST /projects/{project_id}/transfer_requests

Set VPC endpoint restriction. Sets or updates a VPC endpoint restriction for a Neon project. When a VPC endpoint restriction is set, the project only accepts connections from the specified VPC. POST /projects/{project_id}/vpc_endpoints/{vpc_endpoint_id}

Transfer projects from personal account to organization. Deprecated. Personal accounts have been migrated to organizations, so this operation no longer applies. Removal scheduled for July 1, 2026. POST /users/me/projects/transfer

Set organization spending limit. Sets the monthly spending limit for the specified organization. To remove a previously configured limit, send a DELETE request to this endpoint. PUT /organizations/{org_id}/billing/spending_limit

Update auth user role. Updates the role of a user in the Neon Auth user directory for the specified branch. The role controls the user's level of access within the Neon Auth integration. PUT /projects/{project_id}/branches/{branch_id}/auth/users/{auth_user_id}/role

Update Neon Auth webhook configuration. Updates the webhook configuration for the specified branch's Neon Auth integration. Webhooks notify an external endpoint when auth events occur, such as user creation or sign-in. PUT /projects/{project_id}/branches/{branch_id}/auth/webhooks

Update backup schedule. Updates the backup schedule for the specified branch. The schedule defines how often automatic snapshots are created (for example, `daily` or `weekly`). Requires a paid plan. PUT /projects/{project_id}/branches/{branch_id}/backup_schedule

Set an org member's role on a project. Idempotently sets or updates the explicit project grant of the specified org member. Self-demotion requires `confirm_self_demotion=true`. PUT /projects/{project_id}/members/{member_id}/role

Accept a project transfer request. Accepts a transfer request for the specified project, transferring it to the specified organization or user. PUT /projects/{project_id}/transfer_requests/{request_id}