Sign in
Auth Configuration

Send a test email using the project's saved SMTP config

Changed on

Sends a diagnostic email to to_email using the project's persisted auth_config SMTP credentials. If html_body or text_body is supplied, the override path is taken: those values (plus optional subject) are rendered through html/text templates against the project's Data and used as the body — used by the template editor's "Send Test" affordance to preview an unsaved template. With both bodies omitted, a hardcoded diagnostic message is sent and any subject field is ignored. Sending subject alone (no bodies) is rejected with 400 to avoid a silently-dropped subject or a blank message. Also rejects with 400 if email_enabled=false or smtp_host is empty.

post/projects/{id}/auth/config/test-email

Request

  • Base URL: https://api.volcano.dev
  • URL: https://api.volcano.dev/projects/{id}/auth/config/test-email
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

idstring uuid required

Project ID

Request body

to_emailstring email required

Recipient address for the diagnostic email.

subjectstring

Optional subject override, rendered as a text/template. Only applied on the override path — requires html_body or text_body to also be set, otherwise the request is rejected with 400.

html_bodystring

Optional HTML body override. Rendered as an html/template. Max 256 KiB.

text_bodystring

Optional plain-text body override. Rendered as a text/template. Max 256 KiB.

Response

Test email sent

successboolean required

Changes

  • 23e7875e7c4cRevision changes
    • ○

      the endpoint scheme security ProjectAccessToken was added to the API

  • 3a6f365f3f35Revision changes
    • ▲

      added the new path request parameter id

    • ▲

      added the new required request property

    • ▲

      the request's body type changed from no type to object

    • ▲

      the response's body type changed from no type to object for status

    • ○

      added the new optional request property

    • ○

      added the new optional request property

    • ○

      added the new optional request property

    • ○

      added the required property to the response with the status