Skip to content

Interface: StartProxyOptions

Options for startProxyServer, adding the listen address.

optional apiKey?: string

When set, local clients must present this value as a bearer token (Authorization: Bearer <key>). Unset leaves the proxy open, which is fine for a loopback bind but should be paired with a key on a wider one.

ProxyServerOptions.apiKey


optional host?: string


optional port?: number


optional retry?: RetryConfig

Policy for absorbing upstream 429s. Omitted defaults to DEFAULT_RETRY (retry on). See RetryConfig.

ProxyServerOptions.retry