# Verify domain ownership via HTTP This function checks whether the account's domains can pass Domain Control Validation (DCV) via an HTTP request. Endpoint: GET /DCV/check_domains_via_http Version: 11.134.0.5 Security: BasicAuth ## Query parameters: - `domain` (string, required) The domains to check. To check more than one domain, repeat or increment the parameter name. For example, , , and . - `dcv_file_allowed_characters` (array) An array of characters that the certificate provider allows in the DCV check file's filename. - `dcv_file_extension` (string) The DCV check file extension that the certificate provider requires. Example: "txt" - `dcv_file_random_character_count` (integer) The number of characters that the certificate provider allows in the DCV check file's filename. Example: 32 - `dcv_file_relative_path` (string) The DCV check file's file path, relative to the domain's document directory. Example: ".well-known/pki-validation" - `dcv_max_redirects` (integer,null) 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 array of objects for the passed value, plus one. This ensures the function will display any redirects causing DCV failures, if any exist. * If you pass a value, this function does limit the number of redirect returns. * Use the UAPI function to list a provider's supported number of redirects. Example: 2 - `dcv_user_agent_string` (string) The user agent string that the system uses for the imitated local DCV check. The default value can change at any time. Example: "SECTIGO+DCV" ## Response 200 fields (application/json): - `apiversion` (integer) The version of the API. Example: 3 - `func` (string) The name of the method called. Example: "check_domains_via_http" - `module` (string) The name of the module called. Example: "DCV" - `result` (object) - `result.data` (array) An array of objects that contains results from each domain's DCV check. The function returns the domain's results in the same order that you pass them in the parameter. - `result.data.failure_reason` (string,null) The reason that the DCV check failed. * — The domain passed the DCV check. Example: "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." - `result.data.redirects` (array) An array of objects that contains DCV check redirect information. This contains data if the return includes a value greater than zero. - `result.data.redirects.content` (string) A message that explains why the function failed. Example: "\\n\\n301 Moved Permanently\\n \\n

Moved Permanently

\\n

The document has moved here.

\\n\\n" - `result.data.redirects.headers` (object) An object that contains the [HTTP::Tiny](http://search.cpan.org/~dagolden/HTTP-Tiny-0.070/lib/HTTP/Tiny.pm) CPAN module returns. This object's contents vary according to the URL's headers. - `result.data.redirects.protocol` (string) The URL's HTTP protocol. Example: "HTTP/1.1" - `result.data.redirects.reason` (string) The HTTP response status message. Example: "Moved Permanently" - `result.data.redirects.redirects` (array,null) An array of objects containing the redirects, if the value exists. - `result.data.redirects.status` (integer) The [HTTP response status code](https://en.wikipedia.org/wiki/List_of_HTTP_status_codes). Example: 301 - `result.data.redirects.success` (any) Whether the server returns a [2XX HTTP status code](https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#2xx_Success). * — The server returns a 2XX status code. * or an empty string — The server does return a 2XX status code. - `result.data.redirects.url` (string) The URL that the function searches for the DCV file. Example: "http://example.com/.well-known/pki-validation/77010217B0CCF0CCF6211602F9A1B2B2.txt" - `result.data.redirects_count` (integer) The number of HTTP redirects that the DCV check follows. - `result.errors` (array,null) List of errors if the API failed. - `result.messages` (array,null) List of messages generated by the API. - `result.metadata` (object) - `result.metadata.transformed` (integer) Post-processing may have transformed the data. Enum: 1 - `result.status` (integer) * - Success. * - Failed. Check the field for more details. Enum: 0, 1 - `result.warnings` (array,null) List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.