Dkim a domain

GET/api/v1/domains/{domain}/dkim
Requires anorganization API keywith the scopedomains:read

Parameters

NameInTypeDescription
domainrequiredpathstringThe domain id, or the domain name itself.

Request

GET/api/v1/domains/{domain}/dkim
curl -X GET 'https://app.mailyte.com/api/v1/domains/yourdomain.com/dkim' \
  -H 'Authorization: Bearer mk_live_YOUR_API_KEY'
The key names its own organization, so no X-Organization-ID header is needed.

Response

Success.

  • dataobject
    • objectstringdkim_key
    • domain_idstring
    • enabledboolean

      Whether a DKIM key has been made. Whether the record is published is checks.dkim.verified on the verification endpoint.

    • selectorstring

      The DKIM selector, always default. The record name is default._domainkey.<your domain>.

    • recordobject

      The record to publish, or null when no key has been generated yet.

      • typestringtxt
      • namestring
      • valuestring

        The public key record. The private half never leaves the mail server.

Returned inside the standard envelope.

Errors

StatusWhen
401The API key is missing, unknown, revoked or expired. All four answer identically, on purpose: distinguishing them would confirm which keys exist.
403The key is valid but may not do this: it lacks the required scope, its IP allowlist does not include you, or this endpoint does not accept API keys.
404No such resource in this organization.
422The request was understood but the values were not acceptable.
429Too many requests, or the organization has spent its sending allowance. `Retry-After` says how long to wait.

Every status, with what causes it and what to do, is on the error reference.