/projects/{project_id}/branches/{branch_id}/auth/email_providerRetrieve email provider configuration
Retrieves the email provider configuration for the specified branch's Neon Auth integration, including the provider type and server settings.
Quick start
curl "https://console.neon.tech/api/v2/projects/$PROJECT_ID/branches/$BRANCH_ID/auth/email_provider" \
-H "Authorization: Bearer $NEON_API_KEY"Every field below is optional. An empty body works too.
neon neon-auth config email-provider getParameters
project_idThe Neon project ID
branch_idThe Neon branch ID
Response
200Returns the email provider configuration for the Neon Auth
Alternative shape: set type: shared to use the shared variant (all fields optional).
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.