Help Center/ Web Application Firewall/ API Reference (Kuala Lumpur Region)/ API/ Protected Website Management in Dedicated Mode/ Querying the Domain Name Configuration in Dedicated Mode
Updated on 2022-08-09 GMT+08:00
View PDF
Share

Querying the Domain Name Configuration in Dedicated Mode

Function

This API is used to query the domain name configuration in dedicated mode.

URI

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

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

host_id

Yes

String

ID of a domain name connected to a dedicated WAF instance

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

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

id

String

Domain name ID

policyid

String

Policy ID

hostname

String

Domain name connected to a cloud WAF instance

domainid

String

ID of the protected domain name

project_id

String

Project ID

access_code

String

CNAME prefix

protocol

String

HTTP protocol

server

Array of PremiumWafServer objects

Origin server details

certificateid

String

Certificate ID

certificatename

String

Certificate

tls

String

Minimum TLS version

cipher

String

Cipher suite code

proxy

Boolean

Whether the proxy is enabled

locked

Integer

Locked state

Default: 0

protect_status

Integer

Protection status

access_status

Integer

Access status

timestamp

Long

Time the domain name was connected to WAF

block_page

BlockPage object

Alarm page

extend

Map<String,String>

Extensible attribute

traffic_mark

TrafficMark object

Traffic identifier (for known attack source rule only)

flag

Map<String,String>

Special domain name tag

mode

String

Special domain name for the dedicated mode (required in special mode, for example, the ELB mode)

pool_ids

Array of strings

ID of the group associated with the domain name (required only in special mode, for example, the ELB mode)
Table 4 PremiumWafServer

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

vpc_id

String

ID of the VPC where the dedicated WAF engine resides. The origin server and the dedicated WAF engine must be in the same subnet.
Table 5 BlockPage

Parameter

Type

Description

template

String

Template name

custom_page

CustomPage object

Custom alarm page

redirect_url

String

Redirection URL
Table 6 CustomPage

Parameter

Type

Description

status_code

String

Returned status code

content_type

String

Page content type

content

String

Page content
Table 7 TrafficMark

Parameter

Type

Description

sip

Array of strings

IP address of the known attack source

cookie

String

cookie

params

String

Parameter

Status code: 400

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error code message

Status code: 401

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error code message

Status code: 500

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