# Neon API Reference

Base URL: https://console.neon.tech/api/v2
Auth: `Authorization: Bearer $NEON_API_KEY`

Interface-specific indexes:

- [API endpoint index](/guides/ai-agents-on-neon-reference-api): all endpoints grouped by resource, each with curl and SDK examples
- [Neon CLI](/guides/apis-sdks-cli): Neon CLI commands, options, and usage
- [OpenAPI spec](https://neon.com/api_spec/release/v2.json): machine-readable schemas for request/response validation and codegen

## AI Gateway

[All ai-gateway endpoints](/guides/apis-sdks-reference-api-ai-gateway)

- [Get branch AI Gateway endpoint](/guides/apis-sdks-reference-api-ai-gateway-get-project-branch-ai-gateway) `GET /projects/{project_id}/branches/{branch_id}/ai_gateway`

## API Keys

[All api-keys endpoints](/guides/apis-sdks-reference-api-api-keys)

- [Create API key](/guides/apis-sdks-reference-api-api-keys-create-api-key) `POST /api_keys`
- [List API keys](/guides/apis-sdks-reference-api-api-keys-list-api-keys) `GET /api_keys`
- [Revoke API key](/guides/apis-sdks-reference-api-api-keys-revoke-api-key) `DELETE /api_keys/{key_id}`

## Authentication

[All auth endpoints](/guides/apis-sdks-reference-api-auth)

- [Add an OAuth provider](/guides/apis-sdks-reference-api-auth-add-branch-neon-auth-oauth-provider) `POST /projects/{project_id}/branches/{branch_id}/auth/oauth_providers`
- [Add domain to redirect\_uri whitelist](/guides/apis-sdks-reference-api-auth-add-branch-neon-auth-trusted-domain) `POST /projects/{project_id}/branches/{branch_id}/auth/domains`
- [Create new auth user](/guides/apis-sdks-reference-api-auth-create-branch-neon-auth-new-user) `POST /projects/{project_id}/branches/{branch_id}/auth/users`
- [Delete auth user](/guides/apis-sdks-reference-api-auth-delete-branch-neon-auth-user) `DELETE /projects/{project_id}/branches/{branch_id}/auth/users/{auth_user_id}`
- [Delete domain from redirect\_uri whitelist](/guides/apis-sdks-reference-api-auth-delete-branch-neon-auth-trusted-domain) `DELETE /projects/{project_id}/branches/{branch_id}/auth/domains`
- [Delete OAuth provider](/guides/apis-sdks-reference-api-auth-delete-branch-neon-auth-oauth-provider) `DELETE /projects/{project_id}/branches/{branch_id}/auth/oauth_providers/{oauth_provider_id}`
- [Disable Neon Auth for the branch](/guides/apis-sdks-reference-api-auth-disable-neon-auth) `DELETE /projects/{project_id}/branches/{branch_id}/auth`
- [Enable Neon Auth for the branch](/guides/apis-sdks-reference-api-auth-create-neon-auth) `POST /projects/{project_id}/branches/{branch_id}/auth`
- [List domains in redirect\_uri whitelist](/guides/apis-sdks-reference-api-auth-list-branch-neon-auth-trusted-domains) `GET /projects/{project_id}/branches/{branch_id}/auth/domains`
- [List OAuth providers for the branch](/guides/apis-sdks-reference-api-auth-list-branch-neon-auth-oauth-providers) `GET /projects/{project_id}/branches/{branch_id}/auth/oauth_providers`
- [Retrieve email and password configuration](/guides/apis-sdks-reference-api-auth-get-neon-auth-email-and-password-config) `GET /projects/{project_id}/branches/{branch_id}/auth/email_and_password`
- [Retrieve email provider configuration](/guides/apis-sdks-reference-api-auth-get-neon-auth-email-provider) `GET /projects/{project_id}/branches/{branch_id}/auth/email_provider`
- [Retrieve localhost allow setting](/guides/apis-sdks-reference-api-auth-get-neon-auth-allow-localhost) `GET /projects/{project_id}/branches/{branch_id}/auth/allow_localhost`
- [Retrieve Neon Auth details for the branch](/guides/apis-sdks-reference-api-auth-get-neon-auth) `GET /projects/{project_id}/branches/{branch_id}/auth`
- [Retrieve Neon Auth plugin configurations](/guides/apis-sdks-reference-api-auth-get-neon-auth-plugin-configs) `GET /projects/{project_id}/branches/{branch_id}/auth/plugins`
- [Retrieve Neon Auth webhook configuration](/guides/apis-sdks-reference-api-auth-get-neon-auth-webhook-config) `GET /projects/{project_id}/branches/{branch_id}/auth/webhooks`
- [Retrieve phone number plugin configuration](/guides/apis-sdks-reference-api-auth-get-neon-auth-phone-number-plugin) `GET /projects/{project_id}/branches/{branch_id}/auth/plugins/phone-number`
- [Send test email using the saved email provider](/guides/apis-sdks-reference-api-auth-send-neon-auth-email-provider-test) `POST /projects/{project_id}/branches/{branch_id}/auth/email_provider/test`
- [Update auth configuration](/guides/apis-sdks-reference-api-auth-update-neon-auth-config) `PATCH /projects/{project_id}/branches/{branch_id}/auth/config`
- [Update auth user role](/guides/apis-sdks-reference-api-auth-update-neon-auth-user-role) `PUT /projects/{project_id}/branches/{branch_id}/auth/users/{auth_user_id}/role`
- [Update email and password configuration](/guides/apis-sdks-reference-api-auth-update-neon-auth-email-and-password-config) `PATCH /projects/{project_id}/branches/{branch_id}/auth/email_and_password`
- [Update email provider configuration](/guides/apis-sdks-reference-api-auth-update-neon-auth-email-provider) `PATCH /projects/{project_id}/branches/{branch_id}/auth/email_provider`
- [Update localhost allow setting](/guides/apis-sdks-reference-api-auth-update-neon-auth-allow-localhost) `PATCH /projects/{project_id}/branches/{branch_id}/auth/allow_localhost`
- [Update magic link plugin configuration](/guides/apis-sdks-reference-api-auth-update-neon-auth-magic-link-plugin) `PATCH /projects/{project_id}/branches/{branch_id}/auth/plugins/magic-link`
- [Update Neon Auth webhook configuration](/guides/apis-sdks-reference-api-auth-update-neon-auth-webhook-config) `PUT /projects/{project_id}/branches/{branch_id}/auth/webhooks`
- [Update OAuth provider](/guides/apis-sdks-reference-api-auth-update-branch-neon-auth-oauth-provider) `PATCH /projects/{project_id}/branches/{branch_id}/auth/oauth_providers/{oauth_provider_id}`
- [Update organization plugin configuration](/guides/apis-sdks-reference-api-auth-update-neon-auth-organization-plugin) `PATCH /projects/{project_id}/branches/{branch_id}/auth/plugins/organization`
- [Update phone number plugin configuration](/guides/apis-sdks-reference-api-auth-update-neon-auth-phone-number-plugin) `PATCH /projects/{project_id}/branches/{branch_id}/auth/plugins/phone-number`
- [Send test email](/guides/apis-sdks-reference-api-auth-send-neon-auth-test-email) `POST /projects/{project_id}/branches/{branch_id}/auth/send_test_email`

## Branches

[All branches endpoints](/guides/apis-sdks-reference-api-branches)

- [Compare database schema](/guides/apis-sdks-reference-api-branches-get-project-branch-schema-comparison) `GET /projects/{project_id}/branches/{branch_id}/compare_schema`
- [Create anonymized branch](/guides/apis-sdks-reference-api-branches-create-project-branch-anonymized) `POST /projects/{project_id}/branch_anonymized`
- [Create branch](/guides/apis-sdks-reference-api-branches-create-project-branch) `POST /projects/{project_id}/branches`
- [Create database](/guides/apis-sdks-reference-api-branches-create-project-branch-database) `POST /projects/{project_id}/branches/{branch_id}/databases`
- [Create role](/guides/apis-sdks-reference-api-branches-create-project-branch-role) `POST /projects/{project_id}/branches/{branch_id}/roles`
- [Delete branch](/guides/apis-sdks-reference-api-branches-delete-project-branch) `DELETE /projects/{project_id}/branches/{branch_id}`
- [Delete database](/guides/apis-sdks-reference-api-branches-delete-project-branch-database) `DELETE /projects/{project_id}/branches/{branch_id}/databases/{database_name}`
- [Delete role](/guides/apis-sdks-reference-api-branches-delete-project-branch-role) `DELETE /projects/{project_id}/branches/{branch_id}/roles/{role_name}`
- [Finalize branch restore from snapshot](/guides/apis-sdks-reference-api-branches-finalize-restore-branch) `POST /projects/{project_id}/branches/{branch_id}/finalize_restore`
- [List branch endpoints](/guides/apis-sdks-reference-api-branches-list-project-branch-endpoints) `GET /projects/{project_id}/branches/{branch_id}/endpoints`
- [List branches](/guides/apis-sdks-reference-api-branches-list-project-branches) `GET /projects/{project_id}/branches`
- [List databases](/guides/apis-sdks-reference-api-branches-list-project-branch-databases) `GET /projects/{project_id}/branches/{branch_id}/databases`
- [List roles](/guides/apis-sdks-reference-api-branches-list-project-branch-roles) `GET /projects/{project_id}/branches/{branch_id}/roles`
- [Reset role password](/guides/apis-sdks-reference-api-branches-reset-project-branch-role-password) `POST /projects/{project_id}/branches/{branch_id}/roles/{role_name}/reset_password`
- [Restore branch to a historical state](/guides/apis-sdks-reference-api-branches-restore-project-branch) `POST /projects/{project_id}/branches/{branch_id}/restore`
- [Retrieve anonymized branch status](/guides/apis-sdks-reference-api-branches-get-anonymized-branch-status) `GET /projects/{project_id}/branches/{branch_id}/anonymized_status`
- [Retrieve branch details](/guides/apis-sdks-reference-api-branches-get-project-branch) `GET /projects/{project_id}/branches/{branch_id}`
- [Retrieve database details](/guides/apis-sdks-reference-api-branches-get-project-branch-database) `GET /projects/{project_id}/branches/{branch_id}/databases/{database_name}`
- [Retrieve database schema](/guides/apis-sdks-reference-api-branches-get-project-branch-schema) `GET /projects/{project_id}/branches/{branch_id}/schema`
- [Retrieve masking rules](/guides/apis-sdks-reference-api-branches-get-masking-rules) `GET /projects/{project_id}/branches/{branch_id}/masking_rules`
- [Retrieve number of branches](/guides/apis-sdks-reference-api-branches-count-project-branches) `GET /projects/{project_id}/branches/count`
- [Retrieve role details](/guides/apis-sdks-reference-api-branches-get-project-branch-role) `GET /projects/{project_id}/branches/{branch_id}/roles/{role_name}`
- [Retrieve role password](/guides/apis-sdks-reference-api-branches-get-project-branch-role-password) `GET /projects/{project_id}/branches/{branch_id}/roles/{role_name}/reveal_password`
- [Set branch as default](/guides/apis-sdks-reference-api-branches-set-default-project-branch) `POST /projects/{project_id}/branches/{branch_id}/set_as_default`
- [Start anonymization](/guides/apis-sdks-reference-api-branches-start-anonymization) `POST /projects/{project_id}/branches/{branch_id}/anonymize`
- [Update branch](/guides/apis-sdks-reference-api-branches-update-project-branch) `PATCH /projects/{project_id}/branches/{branch_id}`
- [Update database](/guides/apis-sdks-reference-api-branches-update-project-branch-database) `PATCH /projects/{project_id}/branches/{branch_id}/databases/{database_name}`
- [Update masking rules](/guides/apis-sdks-reference-api-branches-update-masking-rules) `PATCH /projects/{project_id}/branches/{branch_id}/masking_rules`

## Buckets

[All buckets endpoints](/guides/apis-sdks-reference-api-buckets)

- [Create a bucket on the branch](/guides/apis-sdks-reference-api-buckets-create-project-branch-bucket) `POST /projects/{project_id}/branches/{branch_id}/buckets`
- [Delete a bucket on the branch](/guides/apis-sdks-reference-api-buckets-delete-project-branch-bucket) `DELETE /projects/{project_id}/branches/{branch_id}/buckets/{bucket_name}`
- [Delete an object in a bucket](/guides/apis-sdks-reference-api-buckets-delete-project-branch-bucket-object) `DELETE /projects/{project_id}/branches/{branch_id}/buckets/{bucket_name}/objects/{object_key}`
- [Delete every object under a key prefix (folder) in a bucket](/guides/apis-sdks-reference-api-buckets-delete-project-branch-bucket-objects-by-prefix) `DELETE /projects/{project_id}/branches/{branch_id}/buckets/{bucket_name}/objects-by-prefix`
- [Download an object's bytes](/guides/apis-sdks-reference-api-buckets-get-project-branch-bucket-object) `GET /projects/{project_id}/branches/{branch_id}/buckets/{bucket_name}/objects/{object_key}/download`
- [List buckets on the branch](/guides/apis-sdks-reference-api-buckets-list-project-branch-buckets) `GET /projects/{project_id}/branches/{branch_id}/buckets`
- [List objects in a bucket](/guides/apis-sdks-reference-api-buckets-list-project-branch-bucket-objects) `GET /projects/{project_id}/branches/{branch_id}/buckets/{bucket_name}/objects`
- [Presign an upload or download for an object in a bucket](/guides/apis-sdks-reference-api-buckets-presign-project-branch-bucket-object) `POST /projects/{project_id}/branches/{branch_id}/buckets/{bucket_name}/objects/{object_key}/presign`

## Consumption

[All consumption endpoints](/guides/apis-sdks-reference-api-consumption)

- [Retrieve branch consumption metrics](/guides/apis-sdks-reference-api-consumption-get-consumption-history-per-branch-v2) `GET /consumption_history/v2/branches`
- [Retrieve project consumption metrics](/guides/apis-sdks-reference-api-consumption-get-consumption-history-per-project-v2) `GET /consumption_history/v2/projects`
- [Retrieve project consumption metrics (legacy plans)](/guides/apis-sdks-reference-api-consumption-get-consumption-history-per-project) `GET /consumption_history/projects`

## Credentials

[All credentials endpoints](/guides/apis-sdks-reference-api-credentials)

- [Issue a scoped credential on the branch](/guides/apis-sdks-reference-api-credentials-create-credential) `POST /projects/{project_id}/branches/{branch_id}/credentials`
- [List credentials on the branch](/guides/apis-sdks-reference-api-credentials-list-credentials) `GET /projects/{project_id}/branches/{branch_id}/credentials`
- [Reveal a credential's secrets](/guides/apis-sdks-reference-api-credentials-reveal-credential) `POST /projects/{project_id}/branches/{branch_id}/credentials/{token_id}/reveal`
- [Revoke a credential](/guides/apis-sdks-reference-api-credentials-revoke-credential) `DELETE /projects/{project_id}/branches/{branch_id}/credentials/{token_id}`
- [Rotate a credential's secrets](/guides/apis-sdks-reference-api-credentials-rotate-credential) `POST /projects/{project_id}/branches/{branch_id}/credentials/{token_id}/rotate`

## Data API

[All dataapi endpoints](/guides/apis-sdks-reference-api-dataapi)

- [Create Neon Data API](/guides/apis-sdks-reference-api-dataapi-create-project-branch-data-api) `POST /projects/{project_id}/branches/{branch_id}/data-api/{database_name}`
- [Delete Neon Data API](/guides/apis-sdks-reference-api-dataapi-delete-project-branch-data-api) `DELETE /projects/{project_id}/branches/{branch_id}/data-api/{database_name}`
- [Get advisor issues](/guides/apis-sdks-reference-api-dataapi-get-project-advisor-security-issues) `GET /projects/{project_id}/advisors`
- [Retrieve Neon Data API configuration](/guides/apis-sdks-reference-api-dataapi-get-project-branch-data-api) `GET /projects/{project_id}/branches/{branch_id}/data-api/{database_name}`
- [Update Neon Data API](/guides/apis-sdks-reference-api-dataapi-update-project-branch-data-api) `PATCH /projects/{project_id}/branches/{branch_id}/data-api/{database_name}`

## Endpoints

[All endpoints endpoints](/guides/apis-sdks-reference-api-endpoints)

- [Create compute endpoint](/guides/apis-sdks-reference-api-endpoints-create-project-endpoint) `POST /projects/{project_id}/endpoints`
- [Delete compute endpoint](/guides/apis-sdks-reference-api-endpoints-delete-project-endpoint) `DELETE /projects/{project_id}/endpoints/{endpoint_id}`
- [List compute endpoints](/guides/apis-sdks-reference-api-endpoints-list-project-endpoints) `GET /projects/{project_id}/endpoints`
- [Restart compute endpoint](/guides/apis-sdks-reference-api-endpoints-restart-project-endpoint) `POST /projects/{project_id}/endpoints/{endpoint_id}/restart`
- [Retrieve compute endpoint details](/guides/apis-sdks-reference-api-endpoints-get-project-endpoint) `GET /projects/{project_id}/endpoints/{endpoint_id}`
- [Start compute endpoint](/guides/apis-sdks-reference-api-endpoints-start-project-endpoint) `POST /projects/{project_id}/endpoints/{endpoint_id}/start`
- [Suspend compute endpoint](/guides/apis-sdks-reference-api-endpoints-suspend-project-endpoint) `POST /projects/{project_id}/endpoints/{endpoint_id}/suspend`
- [Update compute endpoint](/guides/apis-sdks-reference-api-endpoints-update-project-endpoint) `PATCH /projects/{project_id}/endpoints/{endpoint_id}`

## Functions

[All functions endpoints](/guides/apis-sdks-reference-api-functions)

- [Create a trigger](/guides/apis-sdks-reference-api-functions-create-project-branch-trigger) `POST /projects/{project_id}/branches/{branch_id}/triggers`
- [Delete a custom domain from a branch](/guides/apis-sdks-reference-api-functions-delete-project-branch-custom-domain) `DELETE /projects/{project_id}/branches/{branch_id}/custom-domains/{domain}`
- [Delete a function on the branch](/guides/apis-sdks-reference-api-functions-delete-project-branch-function) `DELETE /projects/{project_id}/branches/{branch_id}/functions/{slug}`
- [Delete a trigger](/guides/apis-sdks-reference-api-functions-delete-project-branch-trigger) `DELETE /projects/{project_id}/branches/{branch_id}/triggers/{trigger_id}`
- [Deploy code to a function](/guides/apis-sdks-reference-api-functions-create-project-branch-function-deployment) `POST /projects/{project_id}/branches/{branch_id}/functions/{slug}/deployments`
- [Get a trigger](/guides/apis-sdks-reference-api-functions-get-project-branch-trigger) `GET /projects/{project_id}/branches/{branch_id}/triggers/{trigger_id}`
- [Get function details](/guides/apis-sdks-reference-api-functions-get-project-branch-function) `GET /projects/{project_id}/branches/{branch_id}/functions/{slug}`
- [List functions on the branch](/guides/apis-sdks-reference-api-functions-list-project-branch-functions) `GET /projects/{project_id}/branches/{branch_id}/functions`
- [List the custom domains on a branch](/guides/apis-sdks-reference-api-functions-list-project-branch-custom-domains) `GET /projects/{project_id}/branches/{branch_id}/custom-domains`
- [List triggers on the branch](/guides/apis-sdks-reference-api-functions-list-project-branch-triggers) `GET /projects/{project_id}/branches/{branch_id}/triggers`
- [Register a custom domain on a branch](/guides/apis-sdks-reference-api-functions-register-project-branch-custom-domain) `POST /projects/{project_id}/branches/{branch_id}/custom-domains`
- [Update a function](/guides/apis-sdks-reference-api-functions-update-project-branch-function) `PATCH /projects/{project_id}/branches/{branch_id}/functions/{slug}`
- [Update a trigger](/guides/apis-sdks-reference-api-functions-update-project-branch-trigger) `PATCH /projects/{project_id}/branches/{branch_id}/triggers/{trigger_id}`

## Logs

[All logs endpoints](/guides/apis-sdks-reference-api-logs)

- [List branch log field values](/guides/apis-sdks-reference-api-logs-list-project-branch-log-field-values) `GET /projects/{project_id}/branches/{branch_id}/logs/fields/{field_name}/values`
- [List branch log fields](/guides/apis-sdks-reference-api-logs-list-project-branch-log-fields) `GET /projects/{project_id}/branches/{branch_id}/logs/fields`
- [Query branch logs](/guides/apis-sdks-reference-api-logs-query-project-branch-logs) `POST /projects/{project_id}/branches/{branch_id}/logs/query`

## Operations

[All operations endpoints](/guides/apis-sdks-reference-api-operations)

- [List operations](/guides/apis-sdks-reference-api-operations-list-project-operations) `GET /projects/{project_id}/operations`
- [Retrieve operation details](/guides/apis-sdks-reference-api-operations-get-project-operation) `GET /projects/{project_id}/operations/{operation_id}`

## Organizations

[All organizations endpoints](/guides/apis-sdks-reference-api-organizations)

- [Assign or update VPC endpoint](/guides/apis-sdks-reference-api-organizations-assign-organization-vpc-endpoint) `POST /organizations/{org_id}/vpc/region/{region_id}/vpc_endpoints/{vpc_endpoint_id}`
- [Create organization API key](/guides/apis-sdks-reference-api-organizations-create-org-api-key) `POST /organizations/{org_id}/api_keys`
- [Create organization invitations](/guides/apis-sdks-reference-api-organizations-create-organization-invitations) `POST /organizations/{org_id}/invitations`
- [Delete VPC endpoint](/guides/apis-sdks-reference-api-organizations-delete-organization-vpc-endpoint) `DELETE /organizations/{org_id}/vpc/region/{region_id}/vpc_endpoints/{vpc_endpoint_id}`
- [List organization API keys](/guides/apis-sdks-reference-api-organizations-list-org-api-keys) `GET /organizations/{org_id}/api_keys`
- [List organization invitations](/guides/apis-sdks-reference-api-organizations-get-organization-invitations) `GET /organizations/{org_id}/invitations`
- [List organization members](/guides/apis-sdks-reference-api-organizations-get-organization-members) `GET /organizations/{org_id}/members`
- [List VPC endpoints](/guides/apis-sdks-reference-api-organizations-list-organization-vpc-endpoints) `GET /organizations/{org_id}/vpc/region/{region_id}/vpc_endpoints`
- [List VPC endpoints across all regions](/guides/apis-sdks-reference-api-organizations-list-organization-vpc-endpoints-all-regions) `GET /organizations/{org_id}/vpc/vpc_endpoints`
- [Remove organization member](/guides/apis-sdks-reference-api-organizations-remove-organization-member) `DELETE /organizations/{org_id}/members/{member_id}`
- [Remove organization spending limit](/guides/apis-sdks-reference-api-organizations-delete-organization-spending-limit) `DELETE /organizations/{org_id}/billing/spending_limit`
- [Retrieve organization details](/guides/apis-sdks-reference-api-organizations-get-organization) `GET /organizations/{org_id}`
- [Retrieve organization member details](/guides/apis-sdks-reference-api-organizations-get-organization-member) `GET /organizations/{org_id}/members/{member_id}`
- [Retrieve organization spending limit](/guides/apis-sdks-reference-api-organizations-get-organization-spending-limit) `GET /organizations/{org_id}/billing/spending_limit`
- [Retrieve VPC endpoint details](/guides/apis-sdks-reference-api-organizations-get-organization-vpc-endpoint-details) `GET /organizations/{org_id}/vpc/region/{region_id}/vpc_endpoints/{vpc_endpoint_id}`
- [Revoke organization API key](/guides/apis-sdks-reference-api-organizations-revoke-org-api-key) `DELETE /organizations/{org_id}/api_keys/{key_id}`
- [Set organization spending limit](/guides/apis-sdks-reference-api-organizations-set-organization-spending-limit) `PUT /organizations/{org_id}/billing/spending_limit`
- [Transfer projects between organizations](/guides/apis-sdks-reference-api-organizations-transfer-projects-from-org-to-org) `POST /organizations/{source_org_id}/projects/transfer`
- [Update role for organization member](/guides/apis-sdks-reference-api-organizations-update-organization-member) `PATCH /organizations/{org_id}/members/{member_id}`

## Projects

[All projects endpoints](/guides/apis-sdks-reference-api-projects)

- [Accept a project transfer request](/guides/apis-sdks-reference-api-projects-accept-project-transfer-request) `PUT /projects/{project_id}/transfer_requests/{request_id}`
- [Add JWKS URL](/guides/apis-sdks-reference-api-projects-add-project-jwks) `POST /projects/{project_id}/jwks`
- [Create a project transfer request](/guides/apis-sdks-reference-api-projects-create-project-transfer-request) `POST /projects/{project_id}/transfer_requests`
- [Create project](/guides/apis-sdks-reference-api-projects-create-project) `POST /projects`
- [Delete JWKS URL](/guides/apis-sdks-reference-api-projects-delete-project-jwks) `DELETE /projects/{project_id}/jwks/{jwks_id}`
- [Delete project](/guides/apis-sdks-reference-api-projects-delete-project) `DELETE /projects/{project_id}`
- [Delete VPC endpoint restriction](/guides/apis-sdks-reference-api-projects-delete-project-vpc-endpoint) `DELETE /projects/{project_id}/vpc_endpoints/{vpc_endpoint_id}`
- [Grant project access](/guides/apis-sdks-reference-api-projects-grant-permission-to-project) `POST /projects/{project_id}/permissions`
- [List available shared preload libraries](/guides/apis-sdks-reference-api-projects-get-available-preload-libraries) `GET /projects/{project_id}/available_preload_libraries`
- [List JWKS URLs](/guides/apis-sdks-reference-api-projects-get-project-jwks) `GET /projects/{project_id}/jwks`
- [List org members and their project roles](/guides/apis-sdks-reference-api-projects-list-project-members) `GET /projects/{project_id}/members`
- [List project access](/guides/apis-sdks-reference-api-projects-list-project-permissions) `GET /projects/{project_id}/permissions`
- [List projects](/guides/apis-sdks-reference-api-projects-list-projects) `GET /projects`
- [List shared projects](/guides/apis-sdks-reference-api-projects-list-shared-projects) `GET /projects/shared`
- [List VPC endpoint restrictions](/guides/apis-sdks-reference-api-projects-list-project-vpc-endpoints) `GET /projects/{project_id}/vpc_endpoints`
- [Recover a deleted project](/guides/apis-sdks-reference-api-projects-recover-project) `POST /projects/{project_id}/recover`
- [Remove an org member's role on a project](/guides/apis-sdks-reference-api-projects-remove-project-member-role) `DELETE /projects/{project_id}/members/{member_id}/role`
- [Retrieve connection URI](/guides/apis-sdks-reference-api-projects-get-connection-uri) `GET /projects/{project_id}/connection_uri`
- [Retrieve project details](/guides/apis-sdks-reference-api-projects-get-project) `GET /projects/{project_id}`
- [Revoke project access](/guides/apis-sdks-reference-api-projects-revoke-permission-from-project) `DELETE /projects/{project_id}/permissions/{permission_id}`
- [Set an org member's role on a project](/guides/apis-sdks-reference-api-projects-set-project-member-role) `PUT /projects/{project_id}/members/{member_id}/role`
- [Set VPC endpoint restriction](/guides/apis-sdks-reference-api-projects-assign-project-vpc-endpoint) `POST /projects/{project_id}/vpc_endpoints/{vpc_endpoint_id}`
- [Update project](/guides/apis-sdks-reference-api-projects-update-project) `PATCH /projects/{project_id}`

## Regions

[All regions endpoints](/guides/apis-sdks-reference-api-regions)

- [List supported regions](/guides/apis-sdks-reference-api-regions-get-active-regions) `GET /regions`

## Snapshots

[All snapshots endpoints](/guides/apis-sdks-reference-api-snapshots)

- [Create snapshot](/guides/apis-sdks-reference-api-snapshots-create-snapshot) `POST /projects/{project_id}/branches/{branch_id}/snapshot`
- [Delete snapshot](/guides/apis-sdks-reference-api-snapshots-delete-snapshot) `DELETE /projects/{project_id}/snapshots/{snapshot_id}`
- [List project snapshots](/guides/apis-sdks-reference-api-snapshots-list-snapshots) `GET /projects/{project_id}/snapshots`
- [Restore snapshot](/guides/apis-sdks-reference-api-snapshots-restore-snapshot) `POST /projects/{project_id}/snapshots/{snapshot_id}/restore`
- [Retrieve backup schedule](/guides/apis-sdks-reference-api-snapshots-get-snapshot-schedule) `GET /projects/{project_id}/branches/{branch_id}/backup_schedule`
- [Update backup schedule](/guides/apis-sdks-reference-api-snapshots-set-snapshot-schedule) `PUT /projects/{project_id}/branches/{branch_id}/backup_schedule`
- [Update snapshot](/guides/apis-sdks-reference-api-snapshots-update-snapshot) `PATCH /projects/{project_id}/snapshots/{snapshot_id}`

## Storage

[All storage endpoints](/guides/apis-sdks-reference-api-storage)

- [Get branch object storage state](/guides/apis-sdks-reference-api-storage-get-project-branch-storage) `GET /projects/{project_id}/branches/{branch_id}/storage`

## Users

[All users endpoints](/guides/apis-sdks-reference-api-users)

- [List organizations for the current user](/guides/apis-sdks-reference-api-users-get-current-user-organizations) `GET /users/me/organizations`
- [Retrieve current user details](/guides/apis-sdks-reference-api-users-get-current-user-info) `GET /users/me`
- [Retrieve request authentication details](/guides/apis-sdks-reference-api-users-get-auth-details) `GET /auth`
- [Transfer projects from personal account to organization](/guides/apis-sdks-reference-api-users-transfer-projects-from-user-to-org) `POST /users/me/projects/transfer`

## Legacy Auth

[All auth-legacy endpoints](/guides/apis-sdks-reference-api-auth-legacy)

- [Create Auth Provider SDK keys](/guides/apis-sdks-reference-api-auth-legacy-create-neon-auth-provider-sdk-keys) `POST /projects/auth/keys`
- [Transfer Neon-managed auth project to your own account](/guides/apis-sdks-reference-api-auth-legacy-transfer-neon-auth-provider-project) `POST /projects/auth/transfer_ownership`
- [Add an OAuth provider](/guides/apis-sdks-reference-api-auth-legacy-add-neon-auth-oauth-provider) `POST /projects/{project_id}/auth/oauth_providers`
- [Add trusted redirect URI domain](/guides/apis-sdks-reference-api-auth-legacy-add-neon-auth-domain-to-redirect-uri-whitelist) `POST /projects/{project_id}/auth/domains`
- [Create Neon Auth integration](/guides/apis-sdks-reference-api-auth-legacy-create-neon-auth-integration) `POST /projects/auth/create`
- [Create new auth user](/guides/apis-sdks-reference-api-auth-legacy-create-neon-auth-new-user) `POST /projects/auth/user`
- [Delete auth user](/guides/apis-sdks-reference-api-auth-legacy-delete-neon-auth-user) `DELETE /projects/{project_id}/auth/users/{auth_user_id}`
- [Delete integration with auth provider](/guides/apis-sdks-reference-api-auth-legacy-delete-neon-auth-integration) `DELETE /projects/{project_id}/auth/integration/{auth_provider}`
- [Delete OAuth provider](/guides/apis-sdks-reference-api-auth-legacy-delete-neon-auth-oauth-provider) `DELETE /projects/{project_id}/auth/oauth_providers/{oauth_provider_id}`
- [Delete trusted redirect URI domain](/guides/apis-sdks-reference-api-auth-legacy-delete-neon-auth-domain-from-redirect-uri-whitelist) `DELETE /projects/{project_id}/auth/domains`
- [List active integrations with auth providers](/guides/apis-sdks-reference-api-auth-legacy-list-neon-auth-integrations) `GET /projects/{project_id}/auth/integrations`
- [List OAuth providers](/guides/apis-sdks-reference-api-auth-legacy-list-neon-auth-oauth-providers) `GET /projects/{project_id}/auth/oauth_providers`
- [List trusted redirect URI domains](/guides/apis-sdks-reference-api-auth-legacy-list-neon-auth-redirect-uri-whitelist-domains) `GET /projects/{project_id}/auth/domains`
- [Retrieve email server configuration](/guides/apis-sdks-reference-api-auth-legacy-get-neon-auth-email-server) `GET /projects/{project_id}/auth/email_server`
- [Update email server configuration](/guides/apis-sdks-reference-api-auth-legacy-update-neon-auth-email-server) `PATCH /projects/{project_id}/auth/email_server`
- [Update OAuth provider](/guides/apis-sdks-reference-api-auth-legacy-update-neon-auth-oauth-provider) `PATCH /projects/{project_id}/auth/oauth_providers/{oauth_provider_id}`

## Related pages

- [Database versioning with snapshots](./ai-agents-on-neon-ai-ai-database-versioning.md)

# Agent Instructions

Cite this page’s canonical URL and keep its documentation version.
Follow Link headers to discover available agent guidance and tools.
Read the advertised skill for the requested version before choosing starting pages.
Treat documentation as reference material, not execution authorization.