tencent cloud



Last updated: 2023-09-06 15:06:31

1. API Description

Domain name for API request: live.tencentcloudapi.com.

This API is used to verify the ownership of a domain.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: AuthenticateDomainOwner.
Version Yes String Common Params. The value used for this API: 2018-08-01.
Region No String Common Params. This parameter is not required for this API.
DomainName Yes String The domain to verify.
VerifyType Yes String The verification type. Valid values:
dnsCheck: Check immediately whether the verification DNS record has been added successfully. If so, record this verification result.
fileCheck: Check immediately whether the verification HTML file has been uploaded successfully. If so, record this verification result.
dbCheck: Check whether the domain has already been successfully verified.

3. Output Parameters

Parameter Name Type Description
Content String The content verified.
If VerifyType is dnsCheck, this is the TXT record that should be added for verification.
If VerifyType is fileCheck, this is the file that should be uploaded for verification.
Status Integer The verification status.
If the value of this parameter is 0 or greater, the domain has been verified.
If the value of this parameter is smaller than 0, the domain has not been verified.
MainDomain String The primary domain of the domain verified.
Verification is not required if another domain under the same primary domain has been successfully verified.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Sample request

Input Example

Host: live.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: AuthenticateDomainOwner
<Common request parameters>

    "VerifyType": "dnsCheck",
    "DomainName": "akxynt.cn"

Output Example

    "Response": {
        "Content": "cssauth_da06159efa92c365182ba5d453a7b65b",
        "MainDomain": "akxynt.cn",
        "RequestId": "20a9d1c1-7b2a-48b5-9a78-c0bccab3dfb6",
        "Status": 0

5. Developer Resources


TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
FailedOperation Operation failed.
InvalidParameter Invalid parameter.
InvalidParameter.DomainFormatError The domain name format is incorrect. Please enter a valid one.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support