Help Center> Web Application Firewall> API Reference (Kuala Lumpur Region)> API> Querying the Protected Domain Names> Querying the List of Protection Domain Names

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

View PDF

Querying the List of Protection Domain Names

Function

This API is used to query the list of protection domain names.

URI

GET /v1/{project_id}/composite-waf/host

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

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
page	No	Integer	page Default: 1
pagesize	No	Integer	Number of records on each page. Default: 10
hostname	No	String	Domain name
policyname	No	String	Policy name
protect_status	No	Integer	Protection status of the domain name
waf_type	No	String	WAF mode for the domain name
is_https	No	Boolean	Whether HTTPS is used for the domain name

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

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total	Integer	Number of all protected domain names
cloud_total	Integer	Number of domain names protected with the cloud WAF instance
premium_total	Integer	Number of domain names protected with the dedicated WAF instances
items	Array of CompositeHostResponse objects	Details about the protected domain name

**Table 5** CompositeHostResponse
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
proxy	Boolean	Whether the proxy is enabled
timestamp	Long	Time the domain name was connected to WAF
paid_type	String	Billing mode
flag	HostFlag object	Domain name configuration
waf_type	String	WAF mode of the domain name

**Table 6** HostFlag
Parameter	Type	Description
pci_dss	String	true/false
pci_3ds	String	true/false
cname	String	old/new
is_dual_az	String	true/false
ipv6	String	true/false

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	Insufficient token permissions
500	Internal server error

Error Codes

See Error Codes.

Parent topic: Querying the Protected Domain Names

Previous topic: Querying the Protected Domain Names

Next topic: Querying a Protected Domain Name by ID

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.