/projects/{project_id}/branches/{branch_id}/auth/send_test_emailbetaSend test email
Sends a test email using the configured email server settings to verify SMTP connectivity and credentials.
The request body must include the SMTP server settings
(host, port, username, password, sender_email, sender_name) and the recipient_email address.
Quick start
curl "https://console.neon.tech/api/v2/projects/$PROJECT_ID/branches/$BRANCH_ID/auth/send_test_email" \
-X POST \
-H "Authorization: Bearer $NEON_API_KEY"neon neon-auth config email-provider test \
--host <host> \
--password <password> \
--port <port> \
--recipient-email <recipient-email> \
--sender-email <sender-email> \
--sender-name <sender-name> \
--username <username>Parameters
project_idThe Neon project ID
branch_idThe Neon branch ID
Request body
7 required Required: host, port, username, password, sender_email, sender_name, recipient_email.
hostportusernamepasswordsender_emailsender_namerecipient_emailThe email address to send the test email to.
≥1 chars, ≤256 chars
Response
200Response with the result of the test email send
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.