v1

latestOpenAPI 3.0.02026-07-2634192196.8 KB
filtering-rules

List filtering rules

Lists all filtering rules for the workspace associated with the Management API key. Supports filtering by environment, status, and name.

get/filtering-rules

Query parameters

environmentstring

Filters by environment ID.

status'enabled' | 'disabled'

Filters by rule status.

namestring

Filters by rule name (partial match).

Headers

X-API-Versionstring required

Management API version.

Response

List of filtering rules matching the given query.

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"
    }
  ]
}