proposalbot 2020a02cbb Changes to wafd_api-ref from docs/doc-exports#471 (waf dedicated API 01
waf ded

Reviewed-by: Belejkanic, Lukas <lukas.belejkanic@t-systems.com>
Co-authored-by: proposalbot <proposalbot@otc-service.com>
Co-committed-by: proposalbot <proposalbot@otc-service.com>
2022-12-08 11:52:42 +00:00

6.4 KiB

original_name

DeleteValueList.html

Deleting a Reference Table

Function

This API is used to delete a reference table.

URI

DELETE /v1/{project_id}/waf/valuelist/{valuelistid}

Table 1 Path Parameters
Parameter Mandatory Type Description
project_id Yes String Project ID
valuelistid Yes String Reference table ID. It can be obtained by calling the API Querying the Reference Table List

Request Parameters

Table 2 Request header parameters
Parameter Mandatory Type Description
X-Auth-Token Yes String User token
Content-Type No String

Content type

Default: application/json;charset=utf8

Response Parameters

Status code: 200

Table 3 Response body parameters
Parameter Type Description
id String ID of a reference table
name String Reference table name
type String

The value can be:

  • url
  • params
  • ip
  • cookie
  • referer
  • user-agent
  • header
  • response_code
  • response_header
  • response_body
timestamp String Reference table timestamp

Status code: 400

Table 4 Response body parameters
Parameter Type Description
error_code String Error code
error_msg String Error message

Status code: 401

Table 5 Response body parameters
Parameter Type Description
error_code String Error code
error_msg String Error message

Status code: 500

Table 6 Response body parameters
Parameter Type Description
error_code String Error code
error_msg String Error message

Example Requests

DELETE https://{Endpoint}/v1/{project_id}/waf/valuelist/{valuelistid}?

Example Responses

Status code: 200

Request succeeded.

{
  "id" : "3978ca9403844a62bbd24bb5b8d16d4e",
  "name" : "demo2",
  "type" : "url",
  "values" : [ "/demo" ],
  "timestamp" : 1656495488880
}

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