Waiting for engine...
Skip to main content

ForwardProxy

Configuration for a forward proxy server that routes API Gateway traffic through an intermediary proxy.

type ForwardProxy {
id: ID
enabled: Boolean
hostAddress: String
portNumber: Int
proxyType: ProxyType
username: String
password: String
}

Fields

ForwardProxy.id ● ID scalar miscellaneous

The ID of the forward proxy configuration.

ForwardProxy.enabled ● Boolean scalar miscellaneous

Whether the forward proxy is enabled for this gateway.

ForwardProxy.hostAddress ● String scalar miscellaneous

The host address or IP address of the proxy server.

ForwardProxy.portNumber ● Int scalar miscellaneous

The port number on which the proxy server is listening.

ForwardProxy.proxyType ● ProxyType enum platform

The type of proxy server (HTTP or SOCKS5).

ForwardProxy.username ● String scalar miscellaneous

Username for proxy server authentication.

ForwardProxy.password ● String scalar miscellaneous

Password for proxy server authentication.

Returned By

forwardProxy query ●  forwardProxyUpdate mutation

Member Of

Gateway object

On this Page