Disable Neon Auth for the branch

DELETE /projects/{project_id}/branches/{branch_id}/authbeta

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.

Markdown for AI context

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.

Also available in

neon neon-auth disable

Project ID

project_id

string

The Neon project ID

Branch ID

branch_id

string

The Neon branch ID

No field is required. Send an empty body to use sensible defaults.

Delete data

delete_data

booleandefault: false

If true, deletes the neon_auth schema from the database

200

Delete the integration with the authentication provider

No example available.

default

General error

This endpoint can return the standard Neon API error response.

Response fields

• message Required. Human-readable error message.
• code Required. Machine-readable error code.
• request_id Optional. Request identifier for debugging. You can provide one with the X-Request-ID header.

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.