Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Include Page | ||||
---|---|---|---|---|
|
Description
Excerpt |
---|
This function checks whether the account's domains can pass Domain Control Validation (DCV) via an HTTP request. |
Panel | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Examples
|
Parameters
Parameter | Type | Description | Possible values | Example | |||||||
---|---|---|---|---|---|---|---|---|---|---|---|
domain | string | Required The domains to check.
| A valid domain name. | example.com | |||||||
dcv_file_allowed_characters | array | An array that lists the characters that the certificate provider allows in the DCV check file's filename. This parameter defaults to the following:
| A valid character or characters. |
| |||||||
dcv_file_random_character_count | integer | The number of characters that the certificate provider allows in the DCV check file's filename. This parameter defaults to 100 . | A valid positive integer. | 32 | |||||||
dcv_file_extension | string | The DCV check file extension that the certificate provider requires. This parameter defaults to an empty string. | A valid file extension. | txt | |||||||
dcv_file_relative_path | string | The path to the DCV check file. This parameter defaults to
| A valid file path, relative to the domain's document root directory. | .well-known/pki-validation | |||||||
dcv_user_agent_string | string | The user agent string that the system will use for the imitated local DCV check. This parameter defaults to
| A valid agent string. | COMODO+DCV |
Returns
Return | Type | Description | Possible values | Example | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
data | array of hashes | This array of hashes contains results from each
| This array of hashes contains the |
| ||||||||||||
| array of hashes | This array of hashes contains information about the DCV check redirects.
This function returns this value in the | This array of hashes contains the content , protocol , reason , redirects , status , success , url returns and the headers hash. | |||||||||||||
| string | A message that summarizes why the function did not pass. This function returns this value in the | A valid message. |
| ||||||||||||
| hash | This hash contains information that the The function returns this value in the | A hash of valid header fields.
| |||||||||||||
| string | The URL's HTTP protocol. The function returns this value in the | A valid HTTP protocol. | HTTP/1.1 | ||||||||||||
| string | The HTTP response status code that the server provides. The function returns this value in the | A valid string. | Moved Permanently | ||||||||||||
| array of hashes | An array of hashes of the redirects (in the same order in which the redirections occur), if the value exists. The function returns this value in the | An array of hashes, or | null | ||||||||||||
| integer | The HTTP response status code. The function returns this value in the | A valid status code. | 301 | ||||||||||||
| string | Whether the server returns a The function returns this value in the |
An empty string ( | "" | ||||||||||||
| string | The URL that the function searches for the DCV file. The function returns this value in the | A valid URL. | http://example.com/.well-known/pki-validation/77010217B0CCF0CCF6211602F9A1B2B2.txt | ||||||||||||
| string | The reason that the DCV check fails. The function returns this value in the |
|
| ||||||||||||
| integer | The number of HTTP redirects that the DCV check follows. The function returns this value in the | A valid integer. | 0 |
Panel | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Function information
About this moduleTheDCV module checks Domain Control Validation (DCV).About UAPI
Find a function
Related functions
|