v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB

DCV

Verify Domain Ownership

Verify domain ownership via DNS

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

post/DCV/check_domains_via_dns

Query parameters

domainstring domain required

Example:example.com

The domain or domains to check.

Note:

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

Response

HTTP Request was successful.

apiversioninteger

The version of the API.

funcstring

The name of the method called.

modulestring

The name of the module called.

Example response

{
  "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"
      }
    ],
    "metadata": {
      "transformed": 1
    },
    "status": 1
  }
}