Help Center/ Live/ Cloud Live API Reference/ Domain Name Management/ Configuring the Domain Name IPv6 Function
Updated on 2025-11-06 GMT+08:00
View PDF

Configuring the Domain Name IPv6 Function

Function

Configures the IPv6 function

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

PUT /v1/{project_id}/domain/ipv6-switch

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

Yes

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.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

domain

Yes

String

Domain name

is_ipv6

No

Boolean

Specifies whether to enable the IPv6 function. true indicates that IPv6 is enabled, and false indicates that IPv6 is disabled. The default value is false.

Response Parameters

Status code: 200

IPv6 has been configured.

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error Code

error_msg

String

Error description

Example Requests

Changes IPv6 of a domain name. The domain name is example.com. IPv6 is enabled.

PUT https://{endpoint}/v1/{project_id}/domain/ipv6-switch

{
  "domain" : "example.com",
  "is_ipv6" : true
}

Example Responses

Status code: 400

The parameter is incorrect.

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

Status Codes

Status Code

Description

200

IPv6 has been configured.

400

The parameter is incorrect.

Error Codes

See Error Codes.

Parent topic: Domain Name Management