Obtaining Package Information

Function Description

This API is used to obtain package information of a user.

URI

• URI format

  GET /v1/{project_id}/waf/bundle

• Parameter description

  Table 1 Path parameters

  Parameter	Mandatory	Type	Description
  project_id	Yes	String	Specifies the project ID.

Request

Request parameters

None

Response

Response parameters

Table 2 Parameter description

Parameter	Type	Description
type	Integer	Specifies version information.
name	String	Specifies the package name.
options	Table 3	Specifies the protection switches.
rule	Table 4	Specifies the maximum number of rules in a policy.
host	Table 5	Specifies the maximum number of domain names in a policy.
other	Table 6	Specifies other restrictions in the package.

Table 3 options

Parameter	Type	Description
webattack	Boolean	Specifies whether Basic Web Protection is enabled. true: enabled. false: disabled.
common	Boolean	Specifies whether General Check in Basic Web Protection is enabled. true: enabled. false: disabled.
crawler	Boolean	Specifies whether the master crawler detection switch in Basic Web Protection is enabled. true: enabled. false: disabled. Note If crawler is false, all the subswitches, crawler_engine, crawler_scanner, crawler_script, and crawler_other are invalid.
crawler_engine	Boolean	Specifies whether the Search Engine switch in Basic Web Protection is enabled. true: enabled. false: disabled.
crawler_scanner	Boolean	Specifies whether the Scanner switch in Basic Web Protection is enabled. true: enabled. false: disabled.
crawler_script	Boolean	Specifies whether the Script Tool switch in Basic Web Protection is enabled. true: enabled. false: disabled.
crawler_other	Boolean	Specifies whether detection of other crawlers in Basic Web Protection is enabled. true: enabled. false: disabled.
webshell	Boolean	Specifies whether webshell detection is enabled. true: enabled. false: disabled.
cc	Boolean	Specifies whether CC Attack Protection is enabled. true: enabled. false: disabled.
custom	Boolean	Specifies whether Precise Protection is enabled. true: enabled. false: disabled.
whiteblackip	Boolean	Specifies whether Blacklist and Whitelist is enabled. true: enabled. false: disabled.
privacy	Boolean	Specifies whether Data Masking is enabled. true: enabled. false: disabled.
Ignore	Boolean	Specifies whether False Alarm Masking is enabled. true: enabled. false: disabled.
antitamper	Boolean	Specifies whether Web Tamper Protection is enabled. true: enabled. false: disabled.
full_detection	Boolean	Specifies whether the full detection mode in Precise Protection is enabled. true: full detection. Full detection finishes all threat detections before blocking requests that meet Precise Protection specified conditions. false: instant detection. Instant detection immediately ends threat detection after blocking a request that meets Precise Protection specified conditions.
log_download	Boolean	Specifies whether log download is available. true: available. false: unavailable.

Table 4 rule

Parameter	Type	Description
antitamper	Integer	Specifies the total number of web tamper protection rules. The maximum value is 100.
cc	Integer	Specifies the total number of CC attack protection rules. The maximum value is 100.
custom	Integer	Specifies the total number of precise protection rules. The maximum value is 100.
ignore	Integer	Specifies the total number of false alarm masking rules. The maximum value is 1000.
privacy	Integer	Specifies the total number of data masking rules. The maximum value is 1000.
whiteblackip	Integer	Specifies the total number of blacklist and whitelist rules. The maximum value is 100.

Note

Contact the administrator to increase the maximum values in Table 4.

Table 5 host

Parameter	Type	Description
wildcard	Boolean	Specifies whether a wildcard domain is supported. true: supported. false: unsupported.
ports	Table 7	Specifies the range of ports supported.
protocol	Table 8	Specifies the client protocol.
server	Integer	Specifies the number of backend servers supported. The maximum value is 30.
host	Integer	Specifies the number of subdomain names supported. The maximum value is 100.
domain	Integer	Specifies the number of domain names supported. The maximum value is 100.
cert_num	Integer	Specifies the number of certificates supported. The maximum value is 100.
policy_apply_to	Boolean	Specifies whether a policy can be applied to multiple domain names. true: A policy can be applied to multiple domain names. false: A policy cannot be applied to multiple domain names.
policy_num	Integer	Specifies the number of policies supported. The maximum value is 5000.

Table 6 other

Parameter	Type	Description
default_cc	Integer	Specifies the maximum number of requests from a web visitor in a default CC attack protection policy.

Table 7 ports

Parameter	Type	Description
http	Array	Specifies the list of HTTP ports supported.
https	Array	Specifies the list of HTTPS ports supported.
max_num	Integer	Specifies the number of ports supported.
none_standard	Boolean	Specifies whether non-standard ports are supported. true: Non-standard ports are supported. false: Non-standard ports are not supported.

Table 8 protocol

Parameter	Type	Description
http	Boolean	Specifies whether the HTTP protocol is supported. true: The HTTP protocol is supported. false: The HTTP protocol is not supported.
https	Boolean	Specifies whether the HTTPS protocol is supported. true: The HTTPS protocol is supported. false: The HTTPS protocol is not supported.
http_https	Boolean	Specifies whether the HTTP and HTTPS protocols are supported. true: Both HTTP and HTTPS are supported. false: Neither HTTP nor HTTPS is supported.

Example

Response example

{
  "type": 1,
  "name": "Basic",
  "options": {
    "webattack": true,
    "common": true,
    "crawler": true,
    "webshell": false,
    "cc": false,
    "custom": false,
    "whiteblackip": true,

    "privacy": true,
    "ignore": true,
    "antitamper": false,
"log_download": true,
  },
  "rule": {
    "cc": 0,
    "custom": 0,
    "whiteblackip": 10,

    "privacy": 10,
    "ignore": 1000,
"antitamper": 0,
  },
  "host": {
    "wildcard": false,
    "protocol": {
      "http": true,
      "https": false,
      "http_https": false
    },
    "ports": {
      "none_standard": false,
      "http": [],
      "https": [],
      "max_num": 0
    },
    "domain": 1,
    "host": 10,
    "server": 10,
    "route": false
  },
  "other": {
      "default_cc": 25000
    }
}

Status Code

Table 9 describes the normal status code returned by the API.

Table 9 Status code

Status Code	Description	Meaning
200	OK	The request has succeeded.

For details about error status codes, see Status Codes.

last updated: 2024-04-19 00:03