v1

latestOpenAPI 3.0.02026-07-2634192196.8 KB

filtering-rules

Bulk create/update filtering rules

Creates or updates multiple filtering rules at once. In "merge" mode (default), rules with IDs are updated and rules without IDs are created. In "overwrite" mode, all existing rules for the given environment are deleted and replaced with the provided rules.

post/filtering-rules/bulk

Headers

X-API-Versionstring required

Management API version.

Request body

mode'merge' | 'overwrite'

Mode for bulk operation. "merge" (default) updates existing rules and creates new ones. "overwrite" deletes all existing rules for the environment and creates new ones.

environmentstring required

Environment ID

Example request

{
  "rules": [
    {
      "name": "Block suspicious IPs",
      "expression": "http.request.ip in cidr('192.168.1.1/32')",
      "action": "deny",
      "deny_with": "Forbidden"
    }
  ],
  "environment": "ae_rrETjdWcfqI6AFsk"
}

Response

List of created/updated filtering rules.

Example response

{
  "data": [
    {
      "id": "tr_abc123xyz",
      "name": "Block suspicious IPs",
      "environment": "ae_rrETjdWcfqI6AFsk",
      "expression": "http.request.ip in cidr('192.168.1.1/32')",
      "action": "deny",
      "status": "enabled",
      "deny_with": "Forbidden",
      "created_at": "2024-05-31T01:24:39.506Z",
      "updated_at": "2024-06-01T10:15:30.123Z"
    }
  ]
}