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

Querying a Domain Name Protected by Cloud WAF by ID

Function

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

URI

GET /v1/{project_id}/waf/instance/{instance_id}

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

instance_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

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 4 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 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

The token does not have required permissions.

500

Internal server error.

Error Codes

See Error Codes.