Dns Provider a domain
/api/v1/domains/{domain}/dns-providerParameters
| Name | In | Type | Description |
|---|---|---|---|
domainrequired | path | string | The domain id, or the domain name itself. |
Request
/api/v1/domains/{domain}/dns-providercurl -X GET 'https://app.mailyte.com/api/v1/domains/yourdomain.com/dns-provider' \
-H 'Authorization: Bearer mk_live_YOUR_API_KEY'const response = await fetch('https://app.mailyte.com/api/v1/domains/yourdomain.com/dns-provider', {
method: 'GET',
headers: {
Authorization: 'Bearer mk_live_YOUR_API_KEY',
},
});
const { data } = await response.json();import requests
response = requests.get(
"https://app.mailyte.com/api/v1/domains/yourdomain.com/dns-provider",
headers={"Authorization": "Bearer mk_live_YOUR_API_KEY"},
)
data = response.json()["data"]<?php
$response = Http::withToken('mk_live_YOUR_API_KEY')
->get('https://app.mailyte.com/api/v1/domains/yourdomain.com/dns-provider');
$data = $response->json('data');require "net/http"
require "json"
uri = URI("https://app.mailyte.com/api/v1/domains/yourdomain.com/dns-provider")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer mk_live_YOUR_API_KEY"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }Response
Success.
dataobjectobjectstringdns_providernameserversarray<string>The domain's NS records. Empty when the domain does not resolve.
providerobjectNull when the nameservers match no provider we recognise. That is an ordinary answer, not an error.
idstringA stable slug, e.g. `cloudflare`.
namestringThe provider's own name, for display.
dns_panel_urlstringA deep link to this domain's DNS settings. Null means NONE exists to give: we recognised the provider, but it has no URL shape we can fill in reliably. It is not unknown and not an error -- the provider is identified either way, so send the customer to `provider.name` by hand rather than showing a failure.
domain_connectobjectWhether the provider advertises the Domain Connect standard, which can apply the records without the customer typing them.
supportedbooleanWhether 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_urlstringWhere to send the customer to apply the records automatically. Null exactly when `supported` is false, and means NONE was discovered -- never that it exists but was withheld. The two fields move together, so branch on `supported` and use this only inside that branch.
Returned inside the standard envelope.
Errors
| Status | When |
|---|---|
401 | The API key is missing, unknown, revoked or expired. All four answer identically, on purpose: distinguishing them would confirm which keys exist. |
403 | The 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. |
404 | No such resource in this organization. |
422 | The request was understood but the values were not acceptable. |
429 | Too 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.