Help Center/ Web Application Firewall/ API Reference (Kuala Lumpur Region)/ API/ Protected Website Management in Dedicated Mode/ Querying the List of Domain Names Connected to Dedicated WAF Instances
Updated on 2022-08-09 GMT+08:00
View PDF
Share

Querying the List of Domain Names Connected to Dedicated WAF Instances

Function

This API is used to query the list of domain names connected to dedicated WAF instances.

URI

GET /v1/{project_id}/premium-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

String

Page number

Default: 1

pagesize

No

String

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

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).

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

total

Integer

Number of all protected domain names

items

Array of SimplePremiumWafHost objects

Details about the protected domain name
Table 5 SimplePremiumWafHost

Parameter

Type

Description

id

String

Domain name ID

hostname

String

Domain name

policyid

String

Policy ID

protect_status

Integer

Protection status

access_status

Integer

Access status

flag

Map<String,String>

Special identifier

mode

String

Dedicated engine identifier in special mode, for example, the ELB mode.

pool_ids

Array of strings

Dedicated engine group to which the domain name in special mode belongs

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error code message

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error code message

Status code: 500

Table 8 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

Invalid request

401

Unauthorized token

500

Internal server error

Error Codes

See Error Codes.