Domains

Refresh a link domain's status

Ask Cloudflare for the current state now, instead of waiting for the automatic check (every few minutes while pending, daily once active). Also restarts automatic checks for a failed link domain. Not in Resend. Requires the domain:write scope; 30 per 10 minutes per team.

post/v1/link-domains/{id}/refresh

Request

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

Path parameters

idstring required

The link domain ID

Response

The link domain with its current status

objectstring required
idstring required
hostnamestring required
domain_idstring nullable required

The sending domain the hostname sits under.

domainstring nullable required
status'pending' | 'active' | 'failed' required

pending until Cloudflare sees the CNAME record and issues the certificate, then active. failed means it will not become active without a change on your side (last_error says why); fix it and refresh. Mail uses the link domain only while it is active.

ssl_statusstring nullable required

The certificate status Cloudflare reports, for troubleshooting.

last_errorstring nullable required

Why the link domain is not active yet, when Cloudflare says.

verified_atstring date-time nullable required

When it first became active.

last_checked_atstring date-time nullable required
created_atstring date-time required

Example response

{
  "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.