doc-exports/docs/wafd/api-ref/UpdatePremiumHost.html

Modifying a Domain Name Protected by a Dedicated WAF Instance

Function

This API is used to modify a domain name protected by a dedicated WAF instance.

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	This API is used to modify a domain name protected by a dedicated WAF instance.

Request Parameters

Table 2 Request header parameters

Parameter	Mandatory	Type	Description
Content-Type	Yes	String	Content type. Default value: application/json;charset=utf8 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 3 Request body parameters

Parameter	Mandatory	Type	Description
proxy	No	Boolean	Whether a proxy is used for the domain name. If your website has no layer-7 proxy server such as CDN and cloud acceleration service deployed in front of WAF and uses only layer-4 load balancers (or NAT), set Proxy Configured to No. Otherwise, Proxy Configured must be set to Yes. This ensures that WAF obtains real IP addresses of website visitors and takes protective actions configured in protection policies.
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. Certifacteid and certificatename are required at the same. If certificateid does not match certificatename, an error is reported.
tls	No	String	Minimum TLS version supported. TLS v1.0 is used by default. The value can be:TLS v1.0TLS v1.1TLS v1.2TLS v1.3
cipher	No	String	Cipher suite. The value can be: cipher_1: ECDHE-ECDSA-AES256-GCM-SHA384:HIGH:!MEDIUM:!LOW:!aNULL:!eNULL:!DES:!MD5:!PSK:!RC4:!kRSA:!SRP:!3DES:!DSS:!EXP:!CAMELLIA:@STRENGTH cipher_2: EECDH+AESGCM:EDH+AESGCM cipher_3: ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-SHA384:RC4:HIGH:!MD5:!aNULL:!eNULL:!NULL:!DH:!EDH cipher_4. ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-SHA384:AES256-SHA256:RC4:HIGH:!MD5:!aNULL:!eNULL:!NULL:!EDH n - cipher_default: ECDHE-RSA-AES256-SHA384:AES256-SHA256:RC4:HIGH:!MD5:!aNULL:!eNULL:!NULL:!DH:!EDH:!AESGCM
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.
block_page	No	BlockPage object	Alarm configuration page

Table 4 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 5 CustomPage

Parameter	Mandatory	Type	Description
status_code	Yes	String	Status Codes
content_type	Yes	String	Content type of alarm page
content	Yes	String	Page content

Response Parameters

Status code: 200

Table 6 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 API described in 2.1.1 Querying Protection Policies.
hostname	String	Domain name added to cloud WAF.
domainid	String	User domain ID
project_id	String	Project ID
protocol	String	HTTP protocol
tls	String	Minimum TLS version supported. TLS v1.0 is used by default. The value can be:TLS v1.0TLS v1.1TLS v1.2TLS v1.3
cipher	String	Cipher suite. The value can be: cipher_1: ECDHE-ECDSA-AES256-GCM-SHA384:HIGH:!MEDIUM:!LOW:!aNULL:!eNULL:!DES:!MD5:!PSK:!RC4:!kRSA:!SRP:!3DES:!DSS:!EXP:!CAMELLIA:@STRENGTH cipher_2: EECDH+AESGCM:EDH+AESGCM cipher_3: ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-SHA384:RC4:HIGH:!MD5:!aNULL:!eNULL:!NULL:!DH:!EDH cipher_4. ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-SHA384:AES256-SHA256:RC4:HIGH:!MD5:!aNULL:!eNULL:!NULL:!EDH n - cipher_default: ECDHE-RSA-AES256-SHA384:AES256-SHA256:RC4:HIGH:!MD5:!aNULL:!eNULL:!NULL:!DH:!EDH:!AESGCM
server	Array of PremiumWafServer objects	Origin server details
certificateid	String	HTTPS certificate ID. It can be obtained by calling the ListCertificates API. n - This parameter is not required when the client protocol is HTTP. n - This parameter is mandatory when the client protocol is HTTPS.
certificatename	String	Certificate name. n - This parameter is not required when the client protocol is HTTP. n - This parameter is mandatory when the client protocol is HTTPS.
proxy	Boolean	Whether the proxy is enabled
locked	Integer	Lock status. This parameter is redundant and can be ignored. Default value: 0 Default: 0
protect_status	Integer	WAF status of the protected domain name. The value can be: -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	Whether a domain name is connected to WAF. 0: The domain name is not connected to the engine instance. 1: The domain name is connected to the engine instance.
timestamp	Long	Time a domain name is added to WAF
flag	Flag object	Special domain name identifier, which is used to store additional domain name configurations
block_page	BlockPage object	Alarm configuration page
extend	Map<String,String>	Extended attribute

Table 7 PremiumWafServer

Parameter	Type	Description
front_protocol	String	Client protocol Enumeration values: HTTP HTTPS
back_protocol	String	Server protocol Enumeration values: HTTP HTTPS
address	String	IP address or domain name of the origin server that the client accesses.
port	Integer	Server port
type	String	The origin server address is an IPv4 or IPv6 address. Default value: ipv4 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. 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 8 Flag

Parameter	Type	Description
pci_3ds	String	Whether PCI 3DS certification check is enabled for the domain name. Currently, this function is not supported. The default value is false. You can ignore this parameter. true: PCI 3DS check is enabled. false: PCI 3DS check is disenabled.
pci_dss	String	Whether PCI DDS certification check is enabled for the domain name. true: PCI DDS check is enabled. false: PCI DDS check is disenabled.

Table 9 BlockPage

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

Table 10 CustomPage

Parameter	Type	Description
status_code	String	Status Codes
content_type	String	Content type of alarm page
content	String	Page content

Status code: 400

Table 11 Response body parameters

Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error message

Status code: 401

Table 12 Response body parameters

Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error message

Status code: 500

Table 13 Response body parameters

Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error message

Example Requests

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

{
  "proxy" : true
}

Example Responses

Status code: 200

Request succeeded.

{
  "id" : "ee896796e1a84f3f85865ae0853d8974",
  "hostname" : "www.demo.com",
  "protocol" : "HTTPS",
  "server" : [ {
    "address" : "1.2.3.4",
    "port" : 443,
    "type" : "ipv4",
    "weight" : 1,
    "front_protocol" : "HTTPS",
    "back_protocol" : "HTTPS",
    "vpc_id" : "ebfc553a-386d-4746-b0c2-18ff3f0e903d"
  } ],
  "proxy" : true,
  "locked" : 0,
  "timestamp" : 1650593801380,
  "flag" : {
    "pci_3ds" : "false",
    "pci_dss" : "false"
  },
  "extend" : { },
  "block_page" : {
    "template" : "default"
  },
  "description" : "",
  "policyid" : "df15d0eb84194950a8fdc615b6c012dc",
  "domainid" : "0ee78615ca08419f81f539d97c9ee353",
  "projectid" : "550500b49078408682d0d4f7d923f3e1",
  "protect_status" : 1,
  "access_status" : 0,
  "certificateid" : "360f992501a64de0a65c50a64d1ca7b3",
  "certificatename" : "certificatename75315"
}

Status Codes

Status Code	Description
200	Request succeeded.
400	Invalid request
401	The token does not have the required permission.
500	Internal server error.

Error Codes

See Error Codes.

Parent topic: Managing Websites Protected in Dedicated Mode