Help Center/ Web Application Firewall/ API Reference (Paris)/ APIs/ Dedicated Mode/ Protection Status and Domain Name Access/ Modifying the Access Status of a Domain Name in Dedicated Mode
Updated on 2024-07-25 GMT+08:00

Modifying the Access Status of a Domain Name in Dedicated Mode

Function

This API is used for modifying the access status of a domain name in dedicated mode.

URI

PUT /v1/{project_id}/premium-waf/host/{host_id}/access_status

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

host_id

Yes

String

ID of the domain name protected by the dedicated WAF engine

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

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

access_status

No

Integer

Whether WAF is connected.

  • 0: disconnected

  • 1: connected

protect_status

No

Integer

WAF status of the protected domain name.

  • -1: Bypassed. Requests are directly sent to the backend servers without passing through WAF.

  • 0: Suspended. WAF only forwards requests for the domain name but does not detect attacks.

  • 1: Enabled. WAF detects attacks based on the configured policy.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

access_status

Integer

Whether WAF is connected.

  • 0: disconnected

  • 1: connected

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error Code

error_msg

String

Error Messages

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error Code

error_msg

String

Error Messages

Status code: 500

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error Code

error_msg

String

Error Messages

Example Requests

PUT https://{Endpoint}/v1/{project_id}/premium-waf/host/{host_id}/access_status

{
  "access_status" : 1
}

Example Responses

Status code: 200

ok

{
  "access_status" : 1,
  "protect_status" : 1
}

Status Codes

Status Code

Description

200

ok

400

Invalid request.

401

The token does not have the required permission.

500

Internal server error.

Error Codes

See Error Codes.