Updated on 2023-09-08 GMT+08:00

Creating a Reference Table

Function

This API is used to add a reference table. A reference table can be used by CC attack protection rules and precise protection rules.

URI

POST /v1/{project_id}/waf/valuelist

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.

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

name

Yes

String

Reference table name. The value can contain a maximum of 64 characters. Only digits, letters, hyphens (-), underscores (_), and periods (.) are allowed.

Minimum: 2

Maximum: 64

type

Yes

String

Reference table type. For details, see the enumeration list.

Minimum: 2

Maximum: 32

Enumeration values:

  • url

  • params

  • ip

  • cookie

  • referer

  • user-agent

  • header

  • response_code

  • response_header

  • response_body

values

Yes

Array of strings

Value of the reference table

description

No

String

Reference table description. The value contains a maximum of 128 characters.

Minimum: 0

Maximum: 128

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

id

String

ID of the reference table

name

String

Reference table name.

type

String

Reference table type

description

String

Reference table description

timestamp

Long

Reference table timestamp

values

Array of strings

Value of the reference table

producer

Integer

Source of the reference table.

  • 1: The reference table was created by you.

  • 2: The reference table was created by the intelligent access control protection.

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

POST https://{Endpoint}/v1/{project_id}/waf/valuelist?enterprise_project_id=0

{
  "name" : "demo",
  "type" : "url",
  "values" : [ "/124" ],
  "description" : "demo"
}

Example Responses

Status code: 200

Request succeeded.

{
  "id" : "e5d9032d8da64d169269175c3e4c2849",
  "name" : "demo",
  "type" : "url",
  "values" : [ "/124" ],
  "timestamp" : 1650524684892,
  "description" : "demo",
  "producer" : 1
}

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.