Update magic link plugin configuration

PATCH /projects/{project_id}/branches/{branch_id}/auth/plugins/magic-link

Updates the magic link plugin configuration for Neon Auth. The magic link plugin enables passwordless authentication via email magic links.

Markdown for AI context

curl "https://console.neon.tech/api/v2/projects/$PROJECT_ID/branches/$BRANCH_ID/auth/plugins/magic-link" \
  -X PATCH \
  -H "Authorization: Bearer $NEON_API_KEY"

Also available in

import { createNeonClient, raw } from '@neon/sdk';

const neon = createNeonClient({ apiKey: process.env.NEON_API_KEY });
const { data } = await raw.updateNeonAuthMagicLinkPlugin({
  client: neon.client,
  path: {
    project_id: process.env.PROJECT_ID,
    branch_id: process.env.BRANCH_ID
  }
});

Project ID

project_id

string

The Neon project ID

Branch ID

branch_id

string

The Neon branch ID

No field is required.

Enabled

enabled

boolean

Whether to enable the magic link plugin.

Expires in

expires_in

integer

Minutes until the magic link expires.

min: 5, max: 1440

Disable sign up

disable_sign_up

boolean

When true, sign-up via magic link is disabled.

200

The magic link plugin configuration has been updated

"enabled": false,req

"expires_in": 5,reqint32min: 5, max: 1440

"disable_sign_up": false,req

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.