Skip to content

IpFilterConfig

Defined in: src/policies/traffic/ip-filter.ts:18

Configuration for the ipFilter policy.

optional allow: string[]

Defined in: src/policies/traffic/ip-filter.ts:20

IPs or CIDR ranges to allow (allowlist mode).


optional deny: string[]

Defined in: src/policies/traffic/ip-filter.ts:22

IPs or CIDR ranges to deny (denylist mode).


optional ipHeaders: string[]

Defined in: src/policies/traffic/ip-filter.ts:26

Ordered list of headers to inspect for the client IP. Default: ["cf-connecting-ip", "x-forwarded-for"].


optional mode: "allow" | "deny"

Defined in: src/policies/traffic/ip-filter.ts:24

Filter mode. Default: “deny”.


optional skip: (c) => boolean | Promise<boolean>

Defined in: src/policies/types.ts:90

Skip this policy when condition returns true

unknown

boolean | Promise<boolean>

PolicyConfig.skip