Updating Configurations of Domain Names Protected with Cloud WAF

Function

This API is used to update configurations of domain names protected with cloud WAF. The new origin server information will overwrite the old origin server information. If you want to keep the old information, provide them as new data. You can provide only the updated information in the request body.

URI

PATCH /v1/{project_id}/waf/instance/{instance_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. To obtain it, go to Cloud management console and hover the cursor over your username. On the displayed window, choose My Credentials.Then, in the Projects area, view Project ID of the corresponding project.
instance_id	Yes	String	Domain name ID. It can be obtained by calling the ListHost API.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
enterprise_project_id	No	String	You can obtain the ID by calling the ListEnterpriseProject API of EPS.

Request Parameters

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

**Table 4** Request body parameters
Parameter	Mandatory	Type	Description
proxy	No	Boolean	Whether a proxy is used for the protected domain name. false: No proxy is used. true: A proxy is used.
certificateid	No	String	Certificate ID. It can be obtained by calling the ListCertificates API. This parameter is not required when the client protocol is HTTP. This parameter is mandatory when the client protocol is HTTPS.
certificatename	No	String	Certificate name. This parameter is not required when the client protocol is HTTP. This parameter is mandatory when the client protocol is HTTPS.
server	No	Array of CloudWafServer objects	Origin server configuration of the protected domain name
tls	No	String	Minimum TLS version. The value can be TLS v1.0, TLS v1.1, or TLS v1.2. TLS v1.0 is used by default. Enumeration values: TLS v1.0 TLS v1.1 TLS v1.2 TLS v1.3
cipher	No	String	Cipher suite. The value can be cipher_1, cipher_2, cipher_3, cipher_4, or cipher_default: 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 cipher_default: The cryptographic algorithms are ECDHE-RSA-AES256-SHA384:AES256-SHA256:RC4:HIGH:!MD5:!aNULL:!eNULL:!NULL:!DH:!EDH:!AESGCM. Enumeration values: cipher_1 cipher_2 cipher_3 cipher_4 cipher_default
block_page	No	BlockPage object	Alarm page configuration
extend	No	Map<String,String>	Extended field, which is used to save some configuration information about the protected domain name.

**Table 5** CloudWafServer
Parameter	Mandatory	Type	Description
front_protocol	Yes	String	Protocol used by the client to request access to the origin server. Enumeration values: HTTP HTTPS
back_protocol	Yes	String	Protocol used by WAF to forward client requests it received to origin servers Enumeration values: HTTP HTTPS
address	Yes	String	IP address of your origin server requested by the client
port	Yes	Integer	Port used by WAF to forward client requests to the origin server

**Table 6** BlockPage
Parameter	Mandatory	Type	Description
template	Yes	String	Template name
custom_page	No	CustomPage object	Custom alarm page
redirect_url	No	String	URL of the redirected page

**Table 7** CustomPage
Parameter	Mandatory	Type	Description
status_code	Yes	String	Status Codes
content_type	Yes	String	The content type of the custom alarm page. The value can be text/html, text/xml, or application/json.
content	Yes	String	The page content based on the selected page type. For details, see the Web Application Firewall (WAF) User Guide.

Response Parameters

Status code: 200

**Table 8** Response body parameters
Parameter	Type	Description
id	String	Domain name ID
hostname	String	Domain name connected to a cloud WAF instance
policyid	String	Policy ID
domainid	String	Account ID, which is the same as the account ID on the My Credentials page. To go to this page, log in to Cloud management console, hover the cursor over your username, and click My Credentials in the displayed window.
projectid	String	Project ID. To obtain it, go to Cloud management console and hover the cursor over your username. On the displayed window, choose My Credentials.Then, in the Projects area, view Project ID of the corresponding project.
enterprise_project_id	String	Enterprise project ID. To obtain the ID, log in to the Cloud management console first. On the menu bar at the top of the page, choose Enterprise > Project Management. Then, click the project name and view the ID.
protocol	String	Backend protocol type
server	Array of CloudWafServer objects	Origin server configuration of the protected domain name
proxy	Boolean	Whether a proxy is used for the protected domain name. false: No proxy is used. true: A proxy is used.
protect_status	Integer	WAF status of the protected domain name. -1: The WAF protection is bypassed. Requests of the domain name are directly sent to the backend server and do not pass through WAF. 0: The WAF protection is suspended. WAF only forwards requests destined for the domain name and does not detect attacks. 1: The WAF protection is enabled. WAF detects attacks based on the policy you configure.
access_status	Integer	Domain name access status. The value can be 0 or 1. 0: The website traffic has not been routed to WAF. 1: The website traffic has been routed to WAF.
access_code	String	CNAME prefix
locked	Integer	This parameter is reserved, which will be used to freeze a domain name.
timestamp	Long	Time the domain name was added to WAF.
certificateid	String	HTTPS certificate ID.
certificatename	String	Certificate name
tls	String	SSL version Enumeration values: TLS v1.0 TLS v1.1 TLS v1.2 TLS v1.3
cipher	String	Cipher suite. The value can be cipher_1, cipher_2, cipher_3, cipher_4, or cipher_default: 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 cipher_default: The cryptographic algorithms are ECDHE-RSA-AES256-SHA384:AES256-SHA256:RC4:HIGH:!MD5:!aNULL:!eNULL:!NULL:!DH:!EDH:!AESGCM. Enumeration values: cipher_1 cipher_2 cipher_3 cipher_4 cipher_default
block_page	BlockPage object	Alarm page configuration
extend	Map<String,String>	Special identifier, which is used on the console.
flag	Flag object	Special identifier, which is used on the console.
description	String	Domain name description
exclusive_ip	Boolean	Whether to use a dedicated IP address. This parameter is reserved and can be ignored. true: Use a dedicated IP address. false: Do not use a dedicated IP address.
access_progress	Array of Access_progress objects	Access progress, which is used only for the new console (frontend).

**Table 9** CloudWafServer
Parameter	Type	Description
front_protocol	String	Protocol used by the client to request access to the origin server. Enumeration values: HTTP HTTPS
back_protocol	String	Protocol used by WAF to forward client requests it received to origin servers Enumeration values: HTTP HTTPS
address	String	IP address of your origin server requested by the client
port	Integer	Port used by WAF to forward client requests to the origin server

**Table 10** BlockPage
Parameter	Type	Description
template	String	Template name
custom_page	CustomPage object	Custom alarm page
redirect_url	String	URL of the redirected page

**Table 11** CustomPage
Parameter	Type	Description
status_code	String	Status Codes
content_type	String	The content type of the custom alarm page. The value can be text/html, text/xml, or application/json.
content	String	The page content based on the selected page type. For details, see the Web Application Firewall (WAF) User Guide.

**Table 12** Flag
Parameter	Type	Description
pci_3ds	String	Whether the website passes the PCI 3DS certification check. true: The website passed the PCI 3DS certification check. false: The website failed the PCI 3DS certification check. Enumeration values: true false
pci_dss	String	Whether the website passed the PCI DSS certification check. true: The website passed the PCI DSS certification check. false: The website failed the PCI DSS certification check. Enumeration values: true false

**Table 13** Access_progress
Parameter	Type	Description
step	Integer	Step 1: whitelisting WAF IP addresses. 2: testing WAF. modifying DNS record.
status	Integer	Status. The value can be 0 or 1. 0: The step has not been finished. 1: The step has finished.

Status code: 400

**Table 14** Response body parameters
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error message

Status code: 401

**Table 15** Response body parameters
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error message

Status code: 500

**Table 16** Response body parameters
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error message

Example Requests

PATCH https://{Endpoint}/v1/{project_id}/waf/instance/{instance_id}?enterprise_project_id=0

{
  "server" : [ {
    "address" : "x.x.x.x",
    "port" : "80",
    "front_protocol" : "HTTP",
    "back_protocol" : "HTTP"
  }, {
    "front_protocol" : "HTTP",
    "back_protocol" : "HTTP",
    "address" : "x.x.x.x",
    "port" : "80"
  } ]
}

Example Responses

Status code: 200

{
  "id" : "e91ad96e379b4bea84f8fcda3d153370",
  "hostname" : "www.demo.com",
  "protocol" : "HTTP",
  "server" : [ {
    "address" : "x.x.x.x",
    "port" : 80,
    "front_protocol" : "HTTP",
    "back_protocol" : "HTTP"
  }, {
    "address" : "1.1.1.4",
    "port" : 80,
    "front_protocol" : "HTTP",
    "back_protocol" : "HTTP"
  } ],
  "proxy" : false,
  "locked" : 0,
  "timestamp" : 1650423573577,
  "flag" : {
    "pci_3ds" : "false",
    "pci_dss" : "false",
    "cname" : "new"
  },
  "policyid" : "f385eceedf7c4c34a4d1def19eafbe85",
  "domainid" : "d4ecb00b031941ce9171b7bc3386883f",
  "projectid" : "0456cf04d6f64725ab02ed5bd2efdfa4",
  "enterprise_project_id" : "0",
  "protect_status" : 1,
  "access_status" : 0,
  "access_code" : "4f5372610cdc44f7970759fcca138c81",
  "block_page" : {
    "template" : "default"
  },
  "exclusive_ip" : false
}