Partners

Add a mail server name

Add a name under a domain you control and publish the A record in status.setup. The first name becomes your default; pass default: true to make a later one the default. The DNS check runs at once; the proxy issues the certificate on its own. Requires partner:write.

post/mail-hosts

Request

  • Base URL: https://faivelo.com/api/partner
  • URL: https://faivelo.com/api/partner/mail-hosts
  • Auth: HTTP bearer

Request body

hoststring required
defaultboolean

Example request

{
  "host": "mail.yourcompany.com"
}

Response

The name and the check results

successboolean

Example response

{
  "success": true,
  "data": {
    "status": {
      "host": "mail.yourcompany.com",
      "activeHost": "mx.faivelo.com",
      "setup": {
        "name": "mail.yourcompany.com",
        "value": "18.195.1.2"
      },
      "ports": {
        "imapPort": 993,
        "smtpPort": 465
      }
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.