/projects/{project_id}/branches/{branch_id}/authbetaDisable Neon Auth for the branch
Disables the Neon Auth integration for the specified branch, removing the connection
to the authentication provider.
If delete_data is true, also deletes the neon_auth schema and all associated tables
from the branch database.
The integration can be re-enabled by calling POST /projects/{project_id}/branches/{branch_id}/auth.
Quick start
curl "https://console.neon.tech/api/v2/projects/$PROJECT_ID/branches/$BRANCH_ID/auth" \
-X DELETE \
-H "Authorization: Bearer $NEON_API_KEY"Every field below is optional. An empty body works too.
neon neon-auth disableParameters
project_idThe Neon project ID
branch_idThe Neon branch ID
Request body
No field is required. Send an empty body to use sensible defaults.
delete_dataIf true, deletes the neon_auth schema from the database
Response
200Delete the integration with the authentication provider
No example available.
Errors
General error
This endpoint can return the standard Neon API error response.
Response fields
messageRequired. Human-readable error message.codeRequired. Machine-readable error code.request_idOptional. Request identifier for debugging. You can provide one with theX-Request-IDheader.
Retry guidance
If no response is returned, the request may still have reached the server. This is why retry safety depends on the method and status code.
Idempotent methods (GET, HEAD, OPTIONS) are generally safe to retry after a network error or timeout. Non-idempotent methods (POST, PATCH, DELETE, PUT) can change state, so avoid automatic retries unless your workflow can tolerate duplicate effects.
Responses with 423 Locked or 503 Service Unavailable are safe to retry. 423 Locked means the resource is temporarily locked, usually because another operation is in progress.