• Web Application Firewall

waf
  1. Help Center
  2. Web Application Firewall
  3. API Reference
  4. APIs
  5. Protection Status and Domain Setup
  6. Switching the WAF Mode

Switching the WAF Mode

Function Description

This API is used to switch the WAF mode.

URI

  • URI format

    PUT /v1/{project_id}/waf/instance/{instance_id}/protect_status

  • Parameter description
    Table 1 Path parameters

    Parameter

    Mandatory

    Type

    Description

    project_id

    Yes

    String

    Specifies the project ID.

    instance_id

    Yes

    String

    Specifies the instance ID.

Request

Request parameters
Table 2 Parameter description

Parameter

Mandatory

Type

Description

protect_status

Yes

Integer

Specifies the WAF mode of a domain name.

  • 1: enabled.
  • 0: disabled.
  • -1: bypassed. That is, a client sends a request to the server without passing through WAF.

Response

Response parameters

Table 3 Parameter description

Parameter

Mandatory

Type

Description

protect_status

Yes

Integer

Specifies the WAF mode of a domain name.

  • 1: enabled.
  • 0: disabled.
  • -1: bypassed. That is, a client sends a request to the server without passing through WAF.

Examples

protect_status with a value of 1 is used as an example.

  • Request example
    {
        "protect_status": 1
    }
  • Response example
    {
        "protect_status": 1
    }

Status Code

Table 4 describes the normal status code returned by the API.
Table 4 Status code

Status Code

Description

Meaning

200

OK

The request has succeeded.

For details about error status codes, see Status Codes.