Help Center/ Live/ Cloud Live API Reference/ Domain Name Management/ Verifying Domain Name Ownership
Updated on 2026-04-22 GMT+08:00

Verifying Domain Name Ownership

Function

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

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

POST /v1/{project_id}/domain/verification

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

User token. This parameter is mandatory when token authentication is used. The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Authorization

No

String

Authentication information. This parameter is mandatory for AK/SK authentication.

X-Sdk-Date

No

String

Time when the request is sent. This parameter is mandatory for AK/SK authentication.

X-Project-Id

No

String

Project ID. This parameter is mandatory for AK/SK authentication.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

domain

Yes

String

Definition

Domain name.

Constraints

N/A

Range

Length: 1 to 255 characters

Default Value

N/A

verify_type

Yes

String

Definition

Verification method.

Constraints

N/A

Range

  • dns: DNS record-based verification

  • file: file-based verification

Default Value

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

domain

String

Definition

Domain name.

Range

Length: 1 to 255 characters

verify_content

String

Definition

Verification value, which is the DNS record value or file content.

Range

Length: 1 to 255 characters

verify_result

Boolean

Definition

Verification result.

Range

  • true: The ownership is verified.

  • false: The ownership is not confirmed.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

Verifies the ownership of a domain name.

POST https://{endpoint}/v1/{project_id}/domain/verification

{
  "domain" : "pull.example.com",
  "verify_type" : "DNS"
}

Example Responses

Status code: 200

Request succeeded.

{
  "domain" : "example.com",
  "verify_content" : "liveauth_35437cc60f99bc14d6f51528a5496b9d96582828bd506ba74785fdea90c094b2",
  "verify_result" : true
}

Status code: 400

Request failed.

{
  "error_code" : "LIVE.100011001",
  "error_msg" : "Request Illegal"
}

Status Codes

Status Code

Description

200

Request succeeded.

400

Request failed.

Error Codes

See Error Codes.