Help Center/ Web Application Firewall/ API Reference (Kuala Lumpur Region)/ API/ Managing Websites Protected by Cloud WAF/ Adding a Domain Name to Cloud WAF

Updated on 2022-08-09 GMT+08:00

View PDF

Adding a Domain Name to Cloud WAF

Function

This API is used to add a domain name to cloud WAF.

URI

POST /v1/{project_id}/waf/instance

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID

Request Parameters

**Table 2** 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 3** Request body parameters
Parameter	Mandatory	Type	Description
hostname	No	String	Domain name
policyid	No	String	ID of the policy initially applied to the protected domain name
server	No	Array of CloudWafServer objects	Origin server details
certificateid	No	String	Certificate ID
certificatename	No	String	Certificate name
proxy	No	Boolean	Whether a proxy is used
description	No	String	Domain name description

**Table 4** CloudWafServer
Parameter	Mandatory	Type	Description
front_protocol	Yes	String	Client protocol
back_protocol	Yes	String	Server protocol
address	Yes	String	Server address
port	Yes	Integer	Server port
type	No	String	Origin server IP address format. Default: ipv4

Response Parameters

Status code: 200

**Table 5** 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
access_code	String	CNAME prefix
protect_status	Integer	Protection status
access_status	Integer	Access status
protocol	String	Returned client protocol type
certificateid	String	Certificate ID
certificatename	String	Certificate name
server	Array of CloudWafServer objects	Origin server details
proxy	Boolean	Whether the proxy is enabled
timestamp	Long	Time the domain name was connected to WAF
exclusive_ip	Boolean	Whether a dedicated IP address is used

**Table 6** CloudWafServer
Parameter	Type	Description
front_protocol	String	Client protocol
back_protocol	String	Server protocol
address	String	Server address
port	Integer	Server port
type	String	Origin server IP address format. Default: ipv4

Status code: 400

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

Status code: 401

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

Status code: 500

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

Example Requests

None

Example Responses

None

Status Codes

Status Code	Description
200	OK
400	Request failed.
401	The token does not have required permissions.
500	Internal server error.

Error Codes

See Error Codes.

Parent topic: Managing Websites Protected by Cloud WAF

Previous topic: Querying Domain Names Protected by Cloud WAF

Next topic: Modifying the Protection Status for a Domain Name

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.