Skip to content
Stoma

ProxyPolicyConfig

Defined in: packages/gateway/src/policies/proxy.ts:11

Configuration for the proxy policy.

Extends

Section titled “Extends”

Properties

Section titled “Properties”

headers?

Section titled “headers?”

optional headers?: Record<string, string>

Defined in: packages/gateway/src/policies/proxy.ts:13

Headers to add to the proxied request

preserveHost?

Section titled “preserveHost?”

optional preserveHost?: boolean

Defined in: packages/gateway/src/policies/proxy.ts:22

Whether to preserve the inbound Host header when proxying to URL upstreams. Default: false (Host is rewritten to the upstream target host).

skip?

Section titled “skip?”

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

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

Skip this policy when condition returns true

Parameters

Section titled “Parameters”
c
Section titled “c”

unknown

Returns

Section titled “Returns”

boolean | Promise<boolean>

Inherited from

Section titled “Inherited from”

PolicyConfig.skip

stripHeaders?

Section titled “stripHeaders?”

optional stripHeaders?: string[]

Defined in: packages/gateway/src/policies/proxy.ts:15

Headers to strip from the proxied request

timeout?

Section titled “timeout?”

optional timeout?: number

Defined in: packages/gateway/src/policies/proxy.ts:17

Timeout in milliseconds. Default: 30000.