Health

Changed on

Sends a test email to the provided email address. Useful for testing Baserow's email configuration as errors are clearly returned.

post/api/_health/email/

Request

  • Base URL
    https://api.baserow.io (the document declares no server; this is the origin it was published from)
  • URL
    https://api.baserow.io/api/_health/email/
  • Auth
    HTTP bearer

Request body

target_emailstring email required

Response

succeededboolean required

Whether or not the test email was sent successfully.

error_stackstring nullable

The full stack trace and error message if the test email failed.

error_typestring nullable

The type of error that occurred if the test email failed.

errorstring nullable

A short message describing the error that occured if the test email failed

Changes