Help Center/ Live/ Cloud Live API Reference/ Domain Name Management/ Configuring IPv6 for a Domain Name
Updated on 2026-04-22 GMT+08:00

Configuring IPv6 for a Domain Name

Function

This API is used to configure the IPv6 switch for a domain name.

Calling Method

For details, see Calling APIs.

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

Definition

Domain name.

Constraints

N/A

Range

Length: 1 to 255 characters

Default Value

N/A

is_ipv6

No

Boolean

Definition

Whether IPv6 is enabled.

Constraints

N/A

Range

  • true: enabled

  • false: disabled

Default Value

N/A

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.