Verify domain ownership via DNS

This function checks whether the account's domains can pass Domain Control Validation (DCV) via a DNS request.

Authorizations:
query Parameters
domain
required
string <domain>

The domain or domains to check.

Note:

To check multiple domains, increment the parameter name. For example, domain-0, domain-1, and domain-2.

Examples:
domain=domain-0=example.com&domain-1=example2.com
domain=example.com

Responses

Response Schema: application/json
apiversion
integer

The version of the API.

func
string

The name of the method called.

module
string

The name of the module called.

object

Request samples

uapi --user=username DCV check_domains_via_dns domain='example.com'

Response samples

Content type
application/json
{
  • "apiversion": 3,
  • "func": "check_domains_via_dns",
  • "module": "DCV",
  • "result": {
    • "data": [
      • {
        • "dcv_string": "_dcv-test-record=wsWRlG9IsG7KNnLdIsx9Oz2oTw8m5q0imRR9L6LnDBz14sZelvDHqrJyJc6LA0DY",
        • "domain": "example.com",
        • "failure_reason": "The DNS query to _dcv-test-record.example2.org for the DCV challenge returned no TXT record that matches the value _dcv-test-record=wRUFPTN1DskKDG8KHfYM_5cQF5QUGWq1_A2ovO8rKsrIYO_HilAjsQABFCrbJkLX.",
        • "query_results": [
          • "_dcv-test-record=wsWRlG9IsG7KNnLdIsx9Oz2oTw8m5q0imRR9L6LnDBz14sZelvDHqrJyJc6LA0DY"
          ],
        • "succeeded": 1,
        • "zone": "example.com"
        }
      ],
    • "errors": null,
    • "messages": null,
    • "metadata": {
      • "transformed": 1
      },
    • "status": 1,
    • "warnings": null
    }
}