v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB

DCV

Verify Domain Ownership

Verify domain ownership via HTTP

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

get/DCV/check_domains_via_http

Query parameters

domainstring domain required

The domains to check.

Note:

To check more than one domain, repeat or increment the parameter name. For example, domain-1, domain-2, and domain-3.

dcv_file_allowed_charactersstring[]

An array of characters that the certificate provider allows in the DCV check file's filename.

dcv_file_extensionstring

Example:txt

The DCV check file extension that the certificate provider requires.

dcv_file_random_character_countinteger

Example:32

The number of characters that the certificate provider allows in the DCV check file's filename.

dcv_file_relative_pathstring

Example:.well-known/pki-validation

The DCV check file's file path, relative to the domain's document root directory.

dcv_max_redirectsinteger nullable

Example:2

The number of domain redirects the system permits the DCV check to follow. The function checks the provider's supported number of redirects. It will then return the redirect array of objects for the passed value, plus one. This ensures the function will display any redirects causing DCV failures, if any exist.

Note:

If you pass a 0 value, this function does not limit the number of redirect returns.
Use the Market::get_provider_specific_dcv_constraints UAPI function to list a provider's supported number of redirects.

dcv_user_agent_stringstring

Example:SECTIGO+DCV

The user agent string that the system uses for the imitated local DCV check.

Important:

The default value can change at any time.

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_http",
  "module": "DCV",
  "result": {
    "data": [
      {
        "failure_reason": "The system queried for a temporary file at http://example.com/.well-known/pki-validationD01511F4E E535A5442FC378AA946CF41.txt, but the web server responded with the following error: 404 (Not Found). A DNS (Domain Name System) or web server misconfiguration may exist. The domain example.com resolved to an IP address 93.184.216.34 that does not exist on this server.",
        "redirects": [
          {
            "content": "<!DOCTYPE HTML PUBLIC \\\"-//IETF//DTD HTML 2.0//EN\\\">\\n<html><head>\\n<title>301 Moved Permanently</title>\\n </head><body>\\n<h1>Moved Permanently</h1>\\n <p>The document has moved <a href=\\\"http://www.example.com/.well-known/pki-validation/770102 17B0CCF0CCF6211602F9A1B2B2.txt\\\">here</a>.</p>\\n</body></html>\\n",
            "protocol": "HTTP/1.1",
            "reason": "Moved Permanently",
            "status": 301,
            "url": "http://example.com/.well-known/pki-validation/77010217B0CCF0CCF6211602F9A1B2B2.txt"
          }
        ]
      }
    ],
    "metadata": {
      "transformed": 1
    },
    "status": 1
  }
}