Sign in

v4

OpenAPI 3.0.0MIT2026-07-311494532.1 MB
Domains

Retrieve auto-configuration availability

Returns whether DNS auto-configuration (Domain Connect) is available for this domain. When available is false, manualRecords lists the DNS records the customer must add manually.

get/v1/domains/{domain}/auto-configure

Path parameters

domainstring required

Headers

idempotency-keystring

A header for idempotency purposes

Response

OK

availableboolean required
providerNamestring
providerIdstring
reasonstring
reasonCode'disabled' | 'discovery_not_configured' | 'unsupported_provider' | 'incomplete_configuration' | 'provider_settings_unavailable' | 'untrusted_provider_flow' | 'template_not_onboarded'

Example response

{
  "manualRecords": [
    {
      "type": "MX",
      "name": "inbound",
      "content": "inbound-smtp.us-east-1.amazonaws.com",
      "ttl": "Auto",
      "priority": 10
    }
  ]
}