Dns Provider a domain

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

Parameters

NameInTypeDescription
domainrequiredpathstringThe domain id, or the domain name itself.

Request

GET/api/v1/domains/{domain}/dns-provider
curl -X GET 'https://app.mailyte.com/api/v1/domains/yourdomain.com/dns-provider' \
  -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
    • objectstringdns_provider
    • nameserversarray<string>

      The domain's NS records. Empty when the domain does not resolve.

    • providerobject

      Null when the nameservers match no provider we recognise. That is an ordinary answer, not an error.

      • idstring

        A stable slug, e.g. cloudflare.

      • namestring

        The provider's own name, for display.

      • dns_panel_urlstring

        A link straight to this domain's DNS settings at the provider. Null when we know the provider but cannot build a link; send the user to provider.name instead.

    • domain_connectobject

      Whether the provider advertises the Domain Connect standard, which can apply the records without the customer typing them.

      • supportedboolean

        Whether a _domainconnect discovery record was found. False also covers the case where the lookup itself failed, so it means "not detected" rather than "confirmed absent".

      • settings_urlstring

        Where to send the user to add the records automatically. Set only when supported is true.

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.