Autoscaling Report: Production databases on Neon use 2.4x less compute and 50% less cost than if they were running on a provisioned platform.
Neon
    Docs
    Log inSign up
    /API reference/Legacy Auth/Retrieve email server configuration
    GET/projects/{project_id}/auth/email_serverdeprecated

    This endpoint is deprecated. Scheduled for removal on 2026-03-01.

    Retrieve email server configuration

    DEPRECATED, use /projects/{project_id}/branches/{branch_id}/auth/email_provider instead. Gets the email server configuration for the specified project.

    Markdown for AI context

    Quick start

    REST API - curl
    curl "https://console.neon.tech/api/v2/projects/$PROJECT_ID/auth/email_server" \
  -H "Authorization: Bearer $NEON_API_KEY"

    Every field below is optional. An empty body works too.

    Also available in
    import { createApiClient } from '@neondatabase/api-client';

const api = createApiClient({ apiKey: process.env.NEON_API_KEY });
const { data } = await api.getNeonAuthEmailServer(process.env.PROJECT_ID);

    Parameters

    Project ID
    project_id
    string

    The Neon project ID

    Response

    200

    Returns the email server configuration for the Neon Auth

    Alternative shape: set type: shared to use the shared variant (all fields optional).

    Depth
    "host": (string),req
    "port": (integer),req
    "username": (string),req
    "password": (string),req
    "sender_email": (string),req
    "sender_name": (string),req

    Errors

    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.

    Was this page helpful?
    Previous Delete OAuth providerNext Update email server configuration

    On this page

    Copy neon init command