Modifying a Domain Name Protected by a Dedicated WAF Instance

Function

This API is used for modifying domain name settings in dedicated mode.

URI

PUT /v1/{project_id}/premium-waf/host/{host_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID
host_id	Yes	String	ID of the domain name protected by the dedicated WAF engine

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
enterprise_project_id	No	String	ID of the enterprise project. It can be obtained by calling the ListEnterpriseProject API of EPS.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	Yes	String	Content type Default: application/json;charset=utf8
X-Auth-Token	Yes	String	User token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

**Table 4** Request body parameters
Parameter	Mandatory	Type	Description
proxy	No	Boolean	Whether a proxy is used. true: The proxy is enabled. false: The proxy is disabled.
certificateid	No	String	HTTPS certificate ID. It can be obtained by calling the ListCertificates API.
certificatename	No	String	HTTPS certificate name. It can be obtained by calling the ListCertificates API.
locked	No	Integer	Whether the host is locked.
protect_status	No	Integer	WAF status of the protected domain name. -1: Bypassed. Requests are directly sent to the backend servers without passing through WAF. 0: Suspended. WAF only forwards requests for the domain name but does not detect attacks. 1: Enabled. WAF detects attacks based on the configured policy.
access_status	No	Integer	Whether a domain name is connected to WAF. 0: disconnected 1: connected
timestamp	No	Integer	Time stamp
block_page	No	BlockPage object	Alarm configuration page
traffic_mark	No	TrafficMark object	Stream tag
flag	No	Map<String,String>	Special domain name identifier. This parameter is used for console only.
extend	No	Map<String,String>	Extended field
circuit_breaker	No	CircuitBreaker object	Circuit breaker configuration
timeout_config	No	TimeoutConfig object	Timeout settings

**Table 5** BlockPage
Parameter	Mandatory	Type	Description
template	Yes	String	Template name
custom_page	No	CustomPage object	Custom alarm page
redirect_url	No	String	Redirection URL

**Table 6** CustomPage
Parameter	Mandatory	Type	Description
status_code	Yes	String	Status code
content_type	Yes	String	Content type of alarm page
content	Yes	String	Page content

**Table 7** TrafficMark
Parameter	Mandatory	Type	Description
sip	No	Array of strings	IP address in the known attack source rule
cookie	No	String	cookie
params	No	String	Parameters

**Table 8** CircuitBreaker
Parameter	Mandatory	Type	Description
switch	No	Boolean	Circuit breaker switch
dead_num	No	Integer	Threshold for the number of unreachable origin servers.
dead_ratio	No	Number	Threshold for the percentage of unreachable origin servers.
block_time	No	Integer	Time to trigger the circuit breaker for unreachable origin servers.
superposition_num	No	Integer	Number of reached thresholds to trigger the circuit breaker.
suspend_num	No	Integer	Threshold for suspended connections.
sus_block_time	No	Integer	Time to trigger the circuit breaker for suspended connections.

**Table 9** TimeoutConfig
Parameter	Mandatory	Type	Description
connect_timeout	No	Integer	Timeout for WAF to connect to the origin server.
send_timeout	No	Integer	Timeout for WAF to send requests to the origin server.
read_timeout	No	Integer	Timeout for WAF to receive responses from the origin server.

Response Parameters

Status code: 200

**Table 10** Response body parameters
Parameter	Type	Description
id	String	Domain name ID
policyid	String	ID of the policy initially used to the domain name. It can be obtained by calling the ListPolicy API.
hostname	String	Domain name added to dedicated WAF.
domainid	String	User domain ID
project_id	String	Project ID
access_code	String	CNAME prefix
protocol	String	HTTP protocol
server	Array of PremiumWafServer objects	Origin server details
certificateid	String	HTTPS certificate ID. It can be obtained by calling the ListCertificates API. This parameter is not required if Client Protocol is set to HTTP. This parameter is mandatory if Client Protocol is set to HTTPS.
certificatename	String	Certificate name. This parameter is not required if Client Protocol is set to HTTP. This parameter is mandatory if Client Protocol is set to HTTPS.
proxy	Boolean	Whether the proxy is enabled. true: The proxy is enabled. false: The proxy is disabled.
locked	Integer	Locked Status Default: 0
protect_status	Integer	WAF status of the protected domain name. -1: Bypassed. Requests are directly sent to the backend servers without passing through WAF. 0: Suspended. WAF only forwards requests for the domain name but does not detect attacks. 1: Enabled. WAF detects attacks based on the configured policy.
access_status	Integer	Specifies whether a domain name is connected to WAF. 0: disconnected 1: connected
web_tag	String	Website name.
timestamp	Long	Time a domain name is added to WAF.
flag	Flag object	Special domain name identifier. This parameter is used for console only.
block_page	BlockPage object	Alarm configuration page
extend	Map<String,String>	Extended attribute
traffic_mark	TrafficMark object	Stream tag
timeout_config	TimeoutConfig object	Timeout settings
access_progress	Array of Access_progress objects	Redundant parameter. It is used for console only.

**Table 11** PremiumWafServer
Parameter	Type	Description
front_protocol	String	Client protocol used to request access to the origin server. Enumeration values: HTTP HTTPS
back_protocol	String	Server protocol used when WAF forwards client requests to the origin server. Enumeration values: HTTP HTTPS
address	String	Public IP address or domain name of the origin server that the client accesses.
port	Integer	Port number used by the web server. The value ranges from 0 to 65535, for example, 8080.
type	String	The origin server address is an IPv4 or IPv6 address. Enumeration values: ipv4 ipv6
vpc_id	String	VPC ID. Perform the following steps to obtain the VPC ID: 1.Find the name of the VPC where the dedicated engine is located. The VPC name is in the VPC\Subnet column. Log in to the WAF console and choose Instance Management > Dedicated Engine > VPC\Subnet. 2.Log in to the VPC console and click the VPC name. On the page displayed, copy the VPC ID in the VPC Information area.

**Table 12** Flag
Parameter	Type	Description
pci_3ds	String	Whether your website passes PCI 3DS check. true: Your website passed the PCI 3DS check. false: Your website failed the PCI 3DS check. Enumeration values: true false
pci_dss	String	Whether your website passes PCI DSS check true: Your website passed the PCI DSS check. false: Your website failed the PCI DSS check. Enumeration values: true false
cname	String	The CNAME record the domain name is using old: The domain name uses the old CNAME record. new: The domain name uses a new CNAME record. Enumeration values: old new
is_dual_az	String	Whether WAF supports multi-AZ DR. true: WAF supports multi-AZ disaster recovery (DR). false: WAF does not support multi-AZ DR. Enumeration values: true false

**Table 13** BlockPage
Parameter	Type	Description
template	String	Template name
custom_page	CustomPage object	Custom alarm page
redirect_url	String	Redirection URL

**Table 14** CustomPage
Parameter	Type	Description
status_code	String	Status code
content_type	String	Content type of alarm page
content	String	Page content

**Table 15** TrafficMark
Parameter	Type	Description
sip	Array of strings	IP address in the known attack source rule
cookie	String	cookie
params	String	Parameters

**Table 16** TimeoutConfig
Parameter	Type	Description
connect_timeout	Integer	Timeout for WAF to connect to the origin server.
send_timeout	Integer	Timeout for WAF to send requests to the origin server.
read_timeout	Integer	Timeout for WAF to receive responses from the origin server.

**Table 17** Access_progress
Parameter	Type	Description
step	Integer	Step
status	Integer	Status

Status code: 400

**Table 18** Response body parameters
Parameter	Type	Description
error_code	String	Error Code
error_msg	String	Error Messages

Status code: 401

**Table 19** Response body parameters
Parameter	Type	Description
error_code	String	Error Code
error_msg	String	Error Messages

Status code: 500

**Table 20** Response body parameters
Parameter	Type	Description
error_code	String	Error Code
error_msg	String	Error Messages

Example Requests

PUT https://{Endpoint}/v1/{project_id}/premium-waf/host/{host_id}?enterprise_project_id=0

{
  "proxy" : false
}

Example Responses

Status code: 200

{
  "id" : "27995fb98a2d4928a1e453e65ee8117a",
  "hostname" : "www.demo.com",
  "protocol" : "HTTP",
  "server" : [ {
    "address" : "192.168.0.209",
    "port" : 80,
    "type" : "ipv4",
    "weight" : 1,
    "front_protocol" : "HTTP",
    "back_protocol" : "HTTP",
    "vpc_id" : "cf6dbace-b36a-4d51-ae04-52a8459ae247"
  } ],
  "proxy" : false,
  "locked" : 0,
  "timestamp" : 1650590814885,
  "flag" : {
    "pci_3ds" : "false",
    "pci_dss" : "false"
  },
  "description" : "",
  "policyid" : "9555cda636ef4ca294dfe4b14bc94c47",
  "domainid" : "d4ecb00b031941ce9171b7bc3386883f",
  "projectid" : "05e33ecd328025dd2f7fc00696201fb4",
  "enterprise_project_id" : "0",
  "protect_status" : 1,
  "access_status" : 0,
  "web_tag" : ""
}