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

Modifying the Protection Status for a Domain Name

Function

This API is used to obtain the domain name route information.

URI

PUT /v1/{project_id}/waf/instance/{instance_id}/protect-status

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

instance_id

Yes

String

Domain name ID, which can be obtained by querying the domain names protected by cloud WAF.

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
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

protect_status

No

Integer

Protection status. The options are -1, 0, and 1. -1: Bypassed. 0: Suspended. 1: Enabled.

Response Parameters

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error code message

Status code: 401

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error code message

Status code: 500

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error code message

Example Requests

{
  "protect_status" : 0
}

Example Responses

None

Status Codes

Status Code

Description

200

Request succeeded.

400

Request failed.

401

The token does not have required permissions.

500

Internal server error.

Error Codes

See Error Codes.