Domains

List link domains

The team's custom link domains with their status and DNS records. available says whether the feature is on, included_in_plan whether the team's plan has it. Not in Resend. Requires the domain:read scope.

get/v1/link-domains

Request

  • Base URL: https://smtpfa.st/api
  • URL: https://smtpfa.st/api/v1/link-domains
  • Auth: HTTP bearer

Response

Link domains

objectstring required
has_moreboolean required
availableboolean required

Whether custom link domains are available on this server. When false, creating one answers 503.

included_in_planboolean required

Whether the team's plan includes custom link domains (every paid plan). When false, creating one answers 403 and mail uses smtpfa.st links, also through a link domain added earlier.

Example response

{
  "object": "list",
  "data": [
    {
      "object": "link_domain",
      "id": "cmlink123",
      "hostname": "links.example.com",
      "domain": "example.com",
      "ssl_status": "pending_validation",
      "dns_records": [
        {
          "type": "CNAME",
          "name": "links.example.com",
          "value": "links.smtpfa.st",
          "ttl": "Auto",
          "purpose": "Points the link domain at SMTPfast"
        }
      ]
    }
  ]
}

Changes

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