Updated on 2024-04-25 GMT+08:00

Changing the Protection Status of a Domain Name

Function

This API is used to change the protection status of a domain name.

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. To obtain it, go to Cloud management console and hover the cursor over your username. On the displayed window, choose My Credentials.Then, in the Projects area, view Project ID of the corresponding project.

instance_id

Yes

String

Domain name ID. This parameter is used to specify the domain name whose protection status you want to modify. You can obtain the domain name ID by calling the API (ListHost) for querying the list of domain names protected with cloud WAF.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

You can obtain the ID by calling the ListEnterpriseProject API of EPS.

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

Content-Type

Yes

String

Content type.

Default: application/json;charset=utf8

Table 4 Request body parameters

Parameter

Mandatory

Type

Description

protect_status

Yes

Integer

WAF status of the protected domain name.

  • -1: The WAF protection is bypassed. Requests of the domain name are directly sent to the backend server and do not pass through WAF.

  • 0: The WAF protection is suspended. WAF only forwards requests destined for the domain name and does not detect attacks.

  • 1: The WAF protection is enabled. WAF detects attacks based on the policy you configure.

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

protect_status

Integer

WAF status of the protected domain name.

  • -1: The WAF protection is bypassed. Requests of the domain name are directly sent to the backend server and do not pass through WAF.

  • 0: The WAF protection is suspended. WAF only forwards requests destined for the domain name and does not detect attacks.

  • 1: The WAF protection is enabled. WAF detects attacks based on the policy you configure.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

Status code: 500

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

Example Requests

The following shows how to change WAF protection to suspended for a domain name in a specific project. The project ID is specified by project_id, and the domain ID is specified by instance_id.

PUT https://{Endpoint}/v1/{project_id}/waf/instance/{instance_id}/protect-status?enterprise_project_id=0

{
  "protect_status" : 0
}

Example Responses

Status code: 200

Request succeeded.

{
  "protect_status" : 0
}

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.