Help Center/ Web Application Firewall/ API Reference (Kuala Lumpur Region)/ API/ Querying the Protected Domain Names/ Querying a Protected Domain Name by ID
Updated on 2022-08-09 GMT+08:00
View PDF
Share

Querying a Protected Domain Name by ID

Function

This API is used to query a protected domain name by ID.

URI

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

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

host_id

Yes

String

Domain name 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

Response Parameters

Status code: 200

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

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 4 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 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error code message

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error code message

Status code: 500

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