Neon is expanding into a backend: Object Storage, Functions, and AI Gateway now in beta
Neon
    Docs
    Log inSign up
    /APIs & SDKs

    Endpoint index

    Markdown for AI context

    All 163 Neon API endpoints

    GET/projectsList projectsPOST/projectsCreate projectGET/projects/sharedList shared projectsGET/projects/{project_id}Retrieve project detailsPATCH/projects/{project_id}Update projectDELETE/projects/{project_id}Delete projectGET/projects/{project_id}/permissionsList project accessPOST/projects/{project_id}/permissionsGrant project accessDELETE/projects/{project_id}/permissions/{permission_id}Revoke project accessGET/projects/{project_id}/available_preload_librariesList available shared preload librariesPOST/projects/{project_id}/transfer_requestsCreate a project transfer requestPUT/projects/{project_id}/transfer_requests/{request_id}Accept a project transfer requestGET/projects/{project_id}/jwksList JWKS URLsPOST/projects/{project_id}/jwksAdd JWKS URLDELETE/projects/{project_id}/jwks/{jwks_id}Delete JWKS URLGET/projects/{project_id}/connection_uriRetrieve connection URIGET/projects/{project_id}/vpc_endpointsList VPC endpoint restrictionsPOST/projects/{project_id}/vpc_endpoints/{vpc_endpoint_id}Set VPC endpoint restrictionDELETE/projects/{project_id}/vpc_endpoints/{vpc_endpoint_id}Delete VPC endpoint restrictionPOST/projects/{project_id}/recoverRecover a deleted project
    GET/projects/{project_id}/branchesList branchesPOST/projects/{project_id}/branchesCreate branchPOST/projects/{project_id}/branch_anonymizedCreate anonymized branchGET/projects/{project_id}/branches/countRetrieve number of branchesGET/projects/{project_id}/branches/{branch_id}Retrieve branch detailsPATCH/projects/{project_id}/branches/{branch_id}Update branchDELETE/projects/{project_id}/branches/{branch_id}Delete branchPOST/projects/{project_id}/branches/{branch_id}/restoreRestore branch to a historical stateGET/projects/{project_id}/branches/{branch_id}/schemaRetrieve database schemaGET/projects/{project_id}/branches/{branch_id}/compare_schemaCompare database schemaGET/projects/{project_id}/branches/{branch_id}/masking_rulesRetrieve masking rulesPATCH/projects/{project_id}/branches/{branch_id}/masking_rulesUpdate masking rulesGET/projects/{project_id}/branches/{branch_id}/anonymized_statusRetrieve anonymized branch statusPOST/projects/{project_id}/branches/{branch_id}/anonymizeStart anonymizationPOST/projects/{project_id}/branches/{branch_id}/set_as_defaultSet branch as defaultPOST/projects/{project_id}/branches/{branch_id}/finalize_restoreFinalize branch restore from snapshotGET/projects/{project_id}/branches/{branch_id}/endpointsList branch endpointsGET/projects/{project_id}/branches/{branch_id}/databasesList databasesPOST/projects/{project_id}/branches/{branch_id}/databasesCreate databaseGET/projects/{project_id}/branches/{branch_id}/databases/{database_name}Retrieve database detailsPATCH/projects/{project_id}/branches/{branch_id}/databases/{database_name}Update databaseDELETE/projects/{project_id}/branches/{branch_id}/databases/{database_name}Delete databaseGET/projects/{project_id}/branches/{branch_id}/rolesList rolesPOST/projects/{project_id}/branches/{branch_id}/rolesCreate roleGET/projects/{project_id}/branches/{branch_id}/roles/{role_name}Retrieve role detailsDELETE/projects/{project_id}/branches/{branch_id}/roles/{role_name}Delete roleGET/projects/{project_id}/branches/{branch_id}/roles/{role_name}/reveal_passwordRetrieve role passwordPOST/projects/{project_id}/branches/{branch_id}/roles/{role_name}/reset_passwordReset role passwordPOST/projects/{project_id}/branches/{branch_id}/recoverRecover a deleted branch
    GET/projects/{project_id}/endpointsList compute endpointsPOST/projects/{project_id}/endpointsCreate compute endpointGET/projects/{project_id}/endpoints/{endpoint_id}Retrieve compute endpoint detailsPATCH/projects/{project_id}/endpoints/{endpoint_id}Update compute endpointDELETE/projects/{project_id}/endpoints/{endpoint_id}Delete compute endpointPOST/projects/{project_id}/endpoints/{endpoint_id}/startStart compute endpointPOST/projects/{project_id}/endpoints/{endpoint_id}/suspendSuspend compute endpointPOST/projects/{project_id}/endpoints/{endpoint_id}/restartRestart compute endpoint
    PUT/projects/{project_id}/branches/{branch_id}/auth/users/{auth_user_id}/roleUpdate auth user roleGET/projects/{project_id}/branches/{branch_id}/auth/email_and_passwordRetrieve email and password configurationPATCH/projects/{project_id}/branches/{branch_id}/auth/email_and_passwordUpdate email and password configurationGET/projects/{project_id}/branches/{branch_id}/auth/email_providerRetrieve email provider configurationPATCH/projects/{project_id}/branches/{branch_id}/auth/email_providerUpdate email provider configurationGET/projects/{project_id}/branches/{branch_id}/auth/allow_localhostRetrieve localhost allow settingPATCH/projects/{project_id}/branches/{branch_id}/auth/allow_localhostUpdate localhost allow settingGET/projects/{project_id}/branches/{branch_id}/auth/pluginsRetrieve Neon Auth plugin configurationsPATCH/projects/{project_id}/branches/{branch_id}/auth/plugins/organizationUpdate organization plugin configurationPATCH/projects/{project_id}/branches/{branch_id}/auth/configUpdate auth configurationPATCH/projects/{project_id}/branches/{branch_id}/auth/plugins/magic-linkUpdate magic link plugin configurationGET/projects/{project_id}/branches/{branch_id}/auth/plugins/phone-numberRetrieve phone number plugin configurationPATCH/projects/{project_id}/branches/{branch_id}/auth/plugins/phone-numberUpdate phone number plugin configurationGET/projects/{project_id}/branches/{branch_id}/auth/webhooksRetrieve Neon Auth webhook configurationPUT/projects/{project_id}/branches/{branch_id}/auth/webhooksUpdate Neon Auth webhook configurationGET/projects/{project_id}/branches/{branch_id}/authRetrieve Neon Auth details for the branchPOST/projects/{project_id}/branches/{branch_id}/authEnable Neon Auth for the branchDELETE/projects/{project_id}/branches/{branch_id}/authDisable Neon Auth for the branchGET/projects/{project_id}/branches/{branch_id}/auth/domainsList domains in redirect_uri whitelistPOST/projects/{project_id}/branches/{branch_id}/auth/domainsAdd domain to redirect_uri whitelistDELETE/projects/{project_id}/branches/{branch_id}/auth/domainsDelete domain from redirect_uri whitelistPOST/projects/{project_id}/branches/{branch_id}/auth/usersCreate new auth userDELETE/projects/{project_id}/branches/{branch_id}/auth/users/{auth_user_id}Delete auth userGET/projects/{project_id}/branches/{branch_id}/auth/oauth_providersList OAuth providers for the branchPOST/projects/{project_id}/branches/{branch_id}/auth/oauth_providersAdd an OAuth providerPATCH/projects/{project_id}/branches/{branch_id}/auth/oauth_providers/{oauth_provider_id}Update OAuth providerDELETE/projects/{project_id}/branches/{branch_id}/auth/oauth_providers/{oauth_provider_id}Delete OAuth providerPOST/projects/{project_id}/branches/{branch_id}/auth/send_test_emailSend test email
    GET/organizations/{org_id}Retrieve organization detailsGET/organizations/{org_id}/api_keysList organization API keysPOST/organizations/{org_id}/api_keysCreate organization API keyDELETE/organizations/{org_id}/api_keys/{key_id}Revoke organization API keyGET/organizations/{org_id}/membersList organization membersGET/organizations/{org_id}/members/{member_id}Retrieve organization member detailsPATCH/organizations/{org_id}/members/{member_id}Update role for organization memberDELETE/organizations/{org_id}/members/{member_id}Remove organization memberGET/organizations/{org_id}/invitationsList organization invitationsPOST/organizations/{org_id}/invitationsCreate organization invitationsPOST/organizations/{source_org_id}/projects/transferTransfer projects between organizationsGET/organizations/{org_id}/vpc/vpc_endpointsList VPC endpoints across all regionsGET/organizations/{org_id}/vpc/region/{region_id}/vpc_endpointsList VPC endpointsGET/organizations/{org_id}/vpc/region/{region_id}/vpc_endpoints/{vpc_endpoint_id}Retrieve VPC endpoint detailsPOST/organizations/{org_id}/vpc/region/{region_id}/vpc_endpoints/{vpc_endpoint_id}Assign or update VPC endpointDELETE/organizations/{org_id}/vpc/region/{region_id}/vpc_endpoints/{vpc_endpoint_id}Delete VPC endpointGET/organizations/{org_id}/billing/spending_limitRetrieve organization spending limitPUT/organizations/{org_id}/billing/spending_limitSet organization spending limitDELETE/organizations/{org_id}/billing/spending_limitRemove organization spending limit
    GET/api_keysList API keysPOST/api_keysCreate API keyDELETE/api_keys/{key_id}Revoke API key
    GET/users/meRetrieve current user detailsGET/users/me/organizationsList organizations for the current userGET/authRetrieve request authentication detailsPOST/users/me/projects/transferTransfer projects from personal account to organization
    GET/regionsList supported regions
    GET/consumption_history/projectsRetrieve project consumption metrics (legacy plans)GET/consumption_history/v2/projectsRetrieve project consumption metricsGET/consumption_history/v2/branchesRetrieve branch consumption metrics
    GET/projects/{project_id}/operations/{operation_id}Retrieve operation detailsGET/projects/{project_id}/operationsList operations
    POST/projects/{project_id}/branches/{branch_id}/snapshotCreate snapshotGET/projects/{project_id}/snapshotsList project snapshotsPATCH/projects/{project_id}/snapshots/{snapshot_id}Update snapshotDELETE/projects/{project_id}/snapshots/{snapshot_id}Delete snapshotGET/projects/{project_id}/branches/{branch_id}/backup_scheduleRetrieve backup schedulePUT/projects/{project_id}/branches/{branch_id}/backup_scheduleUpdate backup schedulePOST/projects/{project_id}/snapshots/{snapshot_id}/restoreRestore snapshot
    GET/projects/{project_id}/branches/{branch_id}/data-api/{database_name}Retrieve Neon Data API configurationPOST/projects/{project_id}/branches/{branch_id}/data-api/{database_name}Create Neon Data APIPATCH/projects/{project_id}/branches/{branch_id}/data-api/{database_name}Update Neon Data APIDELETE/projects/{project_id}/branches/{branch_id}/data-api/{database_name}Delete Neon Data APIGET/projects/{project_id}/advisorsGet advisor issues
    POST/projects/auth/keysCreate Auth Provider SDK keysPOST/projects/auth/transfer_ownershipTransfer Neon-managed auth project to your own accountPOST/projects/auth/createCreate Neon Auth integrationGET/projects/{project_id}/auth/domainsList trusted redirect URI domainsPOST/projects/{project_id}/auth/domainsAdd trusted redirect URI domainDELETE/projects/{project_id}/auth/domainsDelete trusted redirect URI domainPOST/projects/auth/userCreate new auth userDELETE/projects/{project_id}/auth/users/{auth_user_id}Delete auth userGET/projects/{project_id}/auth/integrationsList active integrations with auth providersGET/projects/{project_id}/auth/oauth_providersList OAuth providersPOST/projects/{project_id}/auth/oauth_providersAdd an OAuth providerPATCH/projects/{project_id}/auth/oauth_providers/{oauth_provider_id}Update OAuth providerDELETE/projects/{project_id}/auth/oauth_providers/{oauth_provider_id}Delete OAuth providerGET/projects/{project_id}/auth/email_serverRetrieve email server configurationPATCH/projects/{project_id}/auth/email_serverUpdate email server configurationDELETE/projects/{project_id}/auth/integration/{auth_provider}Delete integration with auth provider
    GET/projects/{project_id}/branches/{branch_id}/bucketsList buckets on the branchPOST/projects/{project_id}/branches/{branch_id}/bucketsCreate a bucket on the branchDELETE/projects/{project_id}/branches/{branch_id}/buckets/{bucket_name}Delete a bucket on the branchGET/projects/{project_id}/branches/{branch_id}/buckets/{bucket_name}/objectsList objects in a bucketDELETE/projects/{project_id}/branches/{branch_id}/buckets/{bucket_name}/objects/{object_key}Delete an object in a bucketGET/projects/{project_id}/branches/{branch_id}/buckets/{bucket_name}/objects/{object_key}/downloadDownload an object's bytesDELETE/projects/{project_id}/branches/{branch_id}/buckets/{bucket_name}/objects-by-prefixDelete every object under a key prefix (folder) in a bucketPOST/projects/{project_id}/branches/{branch_id}/buckets/{bucket_name}/objects/{object_key}/presignPresign an upload or download for an object in a bucket
    GET/projects/{project_id}/branches/{branch_id}/storageGet branch storage state
    GET/projects/{project_id}/branches/{branch_id}/ai_gatewayGet branch AI Gateway endpoint
    GET/projects/{project_id}/branches/{branch_id}/credentialsList credentials on the branchPOST/projects/{project_id}/branches/{branch_id}/credentialsIssue a scoped credential on the branchDELETE/projects/{project_id}/branches/{branch_id}/credentials/{token_id}Revoke a credential
    GET/projects/{project_id}/branches/{branch_id}/functionsList functions on the branchGET/projects/{project_id}/branches/{branch_id}/functions/{slug}Get function detailsPATCH/projects/{project_id}/branches/{branch_id}/functions/{slug}Update a functionDELETE/projects/{project_id}/branches/{branch_id}/functions/{slug}Delete a function on the branchPOST/projects/{project_id}/branches/{branch_id}/functions/{slug}/deploymentsDeploy code to a function
    Was this page helpful?
    Previous Key conceptsNext Projects