TextKitDocs

Check a link domain DNS records

Looks up the CNAME and TXT records now.

POST/v1/link-domains/{id}/verify

Path Parameters

  • idstringrequired

Details

Both found: the domain is turned on (active); the certificate can take a minute or two. Always 200 with the domain; verification.problem says what is still missing (DNS changes can take a few minutes).

A record proxied by its DNS host shows no CNAME: turn the proxy off for it. Scope: links.

Responses

  • 200LinkDomain

    The domain, with what this check found

  • 401Error

    Missing, malformed, or revoked API key

  • 402Error

    Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged

  • 404Error

    Not found

  • 429Error

    Rate limit or quota exceeded

Response Fields

  • idstring

    Example: ld_a1B2c3D4e5F6.

  • objectlink_domain
  • domainstring

    Example: links.example.com.

  • statuspending_dns, dns_verified, active

    pending_dns: add the records and verify. dns_verified: the records check out and it is being turned on. active: shorten_links uses it.

  • dns_recordsarray of object

    The records to create at your DNS host.

  • dns_records[].typeCNAME, TXT
  • dns_records[].namestring

    Example: links.example.com.

  • dns_records[].valuestring

    Example: links.jointextkit.com.

  • dns_records[].purposestring
  • created_atstring (date-time)
  • verified_atstring (date-time)

    Nullable.

  • activated_atstring (date-time)

    Nullable.

  • last_checkobject

    Nullable.

  • last_check.atstring (date-time)
  • last_check.cnameboolean
  • last_check.txtboolean
  • verificationobject
  • verification.cnameboolean
  • verification.txtboolean
  • verification.problemstring

    Nullable.

Errors

Every error has the same JSON shape, and request_id matches the X-Request-Id response header. Errors lists every code and what to do about it.

  • 401

    Missing, malformed, or revoked API key

  • 402

    Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged

  • 404

    Not found

  • 429

    Rate limit or quota exceeded