Help Center/ Domain Name Service/ API Reference/ APIs/ Private Zone Management/ Setting a Recursive Resolution Proxy for Subdomains in a Private Zone
Updated on 2025-08-19 GMT+08:00
View PDF

Setting a Recursive Resolution Proxy for Subdomains in a Private Zone

Function

This API is used to enable or disable the recursive resolution proxy of subdomains after a private zone is created.

Calling Method

For details, see Calling APIs.

URI

POST /v2/zones/{zone_id}/actions/set-proxy-pattern

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

zone_id

Yes

String

Definition

Zone ID

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

The user token.

The token can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.

For details about how to obtain a user token, seeObtaining a User Token.

Constraints

N/A

Range

N/A

Default Value

N/A
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

proxy_pattern

Yes

String

Definition

Status of the recursive resolution proxy mode for subdomain names of private zones

Constraints

N/A

Range

  • AUTHORITY: The recursive resolution proxy is disabled for the zone.

  • RECURSIVE: The recursive resolution proxy is enabled for the zone.

Default Value

N/A

Response Parameters

Status code: 202

Request accepted

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

code

String

Definition

Error code

Range

N/A

message

String

Definition

Error description

Range

N/A

Status code: 500

Table 5 Response body parameters

Parameter

Type

Description

code

String

Definition

Error code

Range

N/A

message

String

Definition

Error description

Range

N/A

Example Requests

Setting the recursive resolution proxy for the subdomains of a private zone

POST https://{endpoint}/v2/zones/{zone_id}/actions/set-proxy-pattern

{
  "proxy_pattern" : "RECURSIVE"
}

Example Responses

None

Status Codes

Status Code

Description

202

Request accepted

400

Error response

500

Error response

Error Codes

See Error Codes.

Parent topic: Private Zone Management