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 {#id}

The ID of the forward proxy configuration.

ForwardProxy.enabled ● Boolean scalar miscellaneous {#enabled}

Whether the forward proxy is enabled for this gateway.

ForwardProxy.hostAddress ● String scalar miscellaneous {#host-address}

The host address or IP address of the proxy server.

ForwardProxy.portNumber ● Int scalar miscellaneous {#port-number}

The port number on which the proxy server is listening.

ForwardProxy.proxyType ● ProxyType enum platform {#proxy-type}

The type of proxy server (HTTP or SOCKS5).

ForwardProxy.username ● String scalar miscellaneous {#username}

Username for proxy server authentication.

ForwardProxy.password ● String scalar miscellaneous {#password}

Password for proxy server authentication.

Returned By

forwardProxy query ●  forwardProxyUpdate mutation

Member Of

Gateway object