Skip to Content
CLI ReferenceFilter

Filter rules let you explicitly allow or block traffic by domain pattern. Block rules drop matching requests before they reach the proxy pipeline. Allow rules are useful when you want a whitelist — traffic that does not match an allow rule is blocked by default.

Tip: Use --format toon with filter list for a compact visual summary in the terminal.

apxy filter

Create and manage traffic filter rules for the running proxy

Options

  -h, --help   help for filter

Options inherited from parent commands

      --config string         config file (default is ./configs/default.yaml)
      --error-format string   error output format: text|json (default "text")
      --help-format string    help output format: default|agent (default "default")
      --output string         output format: agent|human (default: auto-detect via TTY)
      --verbose               enable verbose output

SEE ALSO

apxy filter disable

Disable a traffic filter rule

Synopsis

Disable a traffic filter rule without removing it, or disable all filter rules with —all. Disabled rules are ignored during matching.

Either —id or —all is required. Use “apxy filter list” to find rule IDs.

apxy filter disable [flags]

Examples

  apxy filter disable --id abc123
  apxy filter disable --all

Options

      --all                  apply to all resources
      --control-url string   control API URL (default "http://127.0.0.1:8081")
      --dry-run              preview what would happen without executing
  -h, --help                 help for disable
      --id string            filter rule ID

Options inherited from parent commands

      --config string         config file (default is ./configs/default.yaml)
      --error-format string   error output format: text|json (default "text")
      --help-format string    help output format: default|agent (default "default")
      --output string         output format: agent|human (default: auto-detect via TTY)
      --verbose               enable verbose output

SEE ALSO

  • apxy filter - Create and manage traffic filter rules for the running proxy

apxy filter edit

Edit a traffic filter rule

Synopsis

Edit an existing traffic filter rule. Only the flags you supply are updated; all other fields remain unchanged.

Flags: —type filter type: block or allow —target target domain pattern to match

apxy filter edit <id> [flags]

Examples

  apxy filter edit abc123 --target "ads2.example.com"
  apxy filter edit abc123 --type allow

Options

      --control-url string   control API URL (default "http://127.0.0.1:8081")
  -h, --help                 help for edit
      --target string        target domain pattern
      --type string          filter type: block|allow

Options inherited from parent commands

      --config string         config file (default is ./configs/default.yaml)
      --error-format string   error output format: text|json (default "text")
      --help-format string    help output format: default|agent (default "default")
      --output string         output format: agent|human (default: auto-detect via TTY)
      --verbose               enable verbose output

SEE ALSO

  • apxy filter - Create and manage traffic filter rules for the running proxy

apxy filter enable

Enable a traffic filter rule

Synopsis

Re-enable a previously disabled traffic filter rule by its unique ID, or enable all filter rules with —all.

Either —id or —all is required. Use “apxy filter list” to find rule IDs.

apxy filter enable [flags]

Examples

  apxy filter enable --id abc123
  apxy filter enable --all

Options

      --all                  apply to all resources
      --control-url string   control API URL (default "http://127.0.0.1:8081")
      --dry-run              preview what would happen without executing
  -h, --help                 help for enable
      --id string            filter rule ID

Options inherited from parent commands

      --config string         config file (default is ./configs/default.yaml)
      --error-format string   error output format: text|json (default "text")
      --help-format string    help output format: default|agent (default "default")
      --output string         output format: agent|human (default: auto-detect via TTY)
      --verbose               enable verbose output

SEE ALSO

  • apxy filter - Create and manage traffic filter rules for the running proxy

apxy filter list

List traffic filter rules

Synopsis

List all configured traffic filter rules, including their IDs, types, and target patterns.

Flags: —format output format: json or toon (default: json)

apxy filter list [flags]

Examples

  apxy filter list
  apxy filter list --format toon

Options

      --control-url string   control API URL (default "http://127.0.0.1:8081")
      --format string        output format: json|toon (default "json")
  -h, --help                 help for list
  -q, --quiet                output only IDs, one per line

Options inherited from parent commands

      --config string         config file (default is ./configs/default.yaml)
      --error-format string   error output format: text|json (default "text")
      --help-format string    help output format: default|agent (default "default")
      --output string         output format: agent|human (default: auto-detect via TTY)
      --verbose               enable verbose output

SEE ALSO

  • apxy filter - Create and manage traffic filter rules for the running proxy

apxy filter remove

Remove a traffic filter rule by ID or all filter rules

Synopsis

Remove a traffic filter rule by its unique ID, or remove all filter rules with —all.

Either —id or —all is required. Use “apxy filter list” to find rule IDs.

apxy filter remove [flags]

Examples

  apxy filter remove --id abc123
  apxy filter remove --all

Options

      --all                  apply to all resources
      --control-url string   control API URL (default "http://127.0.0.1:8081")
      --dry-run              preview what would happen without executing
  -h, --help                 help for remove
      --id string            filter rule ID

Options inherited from parent commands

      --config string         config file (default is ./configs/default.yaml)
      --error-format string   error output format: text|json (default "text")
      --help-format string    help output format: default|agent (default "default")
      --output string         output format: agent|human (default: auto-detect via TTY)
      --verbose               enable verbose output

SEE ALSO

  • apxy filter - Create and manage traffic filter rules for the running proxy

apxy filter set

Add a traffic filter rule to allow or block requests

Synopsis

Add a traffic filter rule that blocks or allows requests matching a domain pattern.

Flags: —type filter type: block or allow (default: block) —target target domain pattern to match

apxy filter set [flags]

Examples

  apxy filter set --type block --target "ads.example.com"
  apxy filter set --type allow --target "*.internal.corp"

Options

      --control-url string   control API URL (default "http://127.0.0.1:8081")
  -h, --help                 help for set
      --target string        target domain pattern
      --type string          filter type: block|allow (default "block")

Options inherited from parent commands

      --config string         config file (default is ./configs/default.yaml)
      --error-format string   error output format: text|json (default "text")
      --help-format string    help output format: default|agent (default "default")
      --output string         output format: agent|human (default: auto-detect via TTY)
      --verbose               enable verbose output

SEE ALSO

  • apxy filter - Create and manage traffic filter rules for the running proxy
Last updated on
TrafficMock