Domains

DNS steps for the customer's actual DNS provider.

Fingerprints the DNS provider from the zone's public NS records and returns steps written for it: the right record type for this position and provider, the record name written the way that provider's form wants it (@ vs blank vs the full domain), where the record editor lives in its UI, and the provider-specific gotchas that silently break a connection. Also reports whether the provider supports one-click Domain Connect, in which case domainConnect.applyUrl sends the customer to approve the change at their own provider. Does live NS and Domain Connect lookups, so it is a separate endpoint rather than a field on the domain resource. Never fails: an unrecognised provider returns provider.detected=false with correct generic steps.

get/v1/domains/{id}/instructions

Request

  • Base URL: https://api.domainee.dev
  • URL: https://api.domainee.dev/v1/domains/{id}/instructions
  • Auth: HTTP bearer

Query parameters

redirect_uristring

Where the customer lands after approving a Domain Connect flow at their provider, with state appended to its query string. Cloudflare accepts any URL; other providers may require the domainee.dev redirect domain declared in the templates, so when opening applyUrl in a popup you can omit it and call POST /v1/domains/{id}/check when the customer returns.

statestring

Opaque value round-tripped through the Domain Connect redirect.

Response

Provider-aware connect instructions.

Example response

{
  "instructions": {
    "provider": {
      "id": "cloudflare",
      "name": "Cloudflare"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.