Neon is expanding into a backend: Object Storage, Functions, and AI Gateway now in beta
Neon
    Docs
    Log inSign up
    /APIs & SDKs/Authentication/Retrieve Neon Auth details for the branch
    GET/projects/{project_id}/branches/{branch_id}/authbeta

    Retrieve Neon Auth details for the branch

    Retrieves the Neon Auth integration details for the specified branch, including the auth provider type and integration status.

    Markdown for AI context

    Quick start

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

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

    Also available in
    neon neon-auth status

    Parameters

    Project ID
    project_id
    string

    The Neon project ID

    Branch ID
    branch_id
    string

    The Neon branch ID

    Response

    200

    Fetched the details of the Neon Auth integration for the specified branch

    Depth
    "auth_provider": (string),reqmock | stack | better_auth
    "auth_provider_project_id": (string),req
    "branch_id": (string),req
    "db_name": (string),req
    "created_at": (string),reqdate-time
    "owned_by": (string),requser | neon
    "jwks_url": (string),req
    "base_url": (string),
    "name": (string),≥1 chars, ≤256 chars
    "transfer_status": (string),initiated | finished

    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 AuthenticationNext Enable Neon Auth for the branch

    On this page

    Copy neon init command