IpFilterConfig

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

Configuration for the ipFilter policy.

Extends

• PolicyConfig

Properties

allow?

optional allow?: string[]

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

IPs or CIDR ranges to allow (allowlist mode).

---

deny?

optional deny?: string[]

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

IPs or CIDR ranges to deny (denylist mode).

---

ipHeaders?

optional ipHeaders?: string[]

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

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

---

mode?

optional mode?: "allow" | "deny"

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

Filter mode. Default: “deny”.

---

skip?

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

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

Skip this policy when condition returns true

Parameters

c

unknown

Returns

boolean | Promise<boolean>

Inherited from

PolicyConfig.skip