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

Bulk create/update filtering rules

cURL

curl --request POST \
  --url https://management-api.fpjs.io/filtering-rules/bulk \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Version: <x-api-version>' \
  --data @- <<EOF
{
  "rules": [
    {
      "name": "Block suspicious IPs",
      "expression": "http.request.ip in cidr('192.168.1.1/32')",
      "action": "deny",
      "status": "enabled",
      "deny_with": "Forbidden",
      "placement": {
        "position": 1,
        "after": "<string>",
        "before": "<string>"
      }
    }
  ],
  "environment": "ae_rrETjdWcfqI6AFsk",
  "mode": "merge"
}
EOF

200

{
  "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",
      "created_at": "2024-05-31T01:24:39.506Z",
      "deny_with": "Forbidden",
      "updated_at": "2024-06-01T10:15:30.123Z"
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-API-Version · string · required

Management API version.

Body

application/json

rules · object[] · required

Array of filtering rules to create or update

Show child attributes

environment · string · required

Environment ID

Example:

"ae_rrETjdWcfqI6AFsk"

mode · enum<string> · default: merge

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.

Available options: merge, overwrite

Response

200

application/json

List of created/updated filtering rules.

data · object[] · required

Show child attributes