Waiting for engine...
Skip to main content

forwardProxyUpdate

Updates the forward proxy configuration for a gateway.

Input Parameters:

  • id: ID of the gateway to update forward proxy configuration for.
  • forwardProxyInput: Proxy configuration including enabled status and connection details.

Response:

  • Returns the updated ForwardProxy object with modified configuration settings.

Example Request:

mutation forwardProxyUpdate($id: ID!, $forwardProxyInput: ForwardProxyInput!) {
forwardProxyUpdate(
id: $id,
forwardProxyInput: $forwardProxyInput
) {
id,
enabled,
hostAddress,
portNumber,
proxyType,
username,
password
}
}

Variables:

{
"id": "<xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx>",
"forwardProxyInput": {
"enabled": true,
"configuration": {
"hostAddress": "127.0.0.1",
"portNumber": 1082,
"proxyType": "SOCKS5",
"credentials": {
"username": "proxy",
"password": "test123"
}
}
}
}

forwardProxyUpdate(
id: ID!
forwardProxyInput: ForwardProxyInput!
): ForwardProxy!

Arguments

forwardProxyUpdate.id ● ID! non-null scalar miscellaneous

forwardProxyUpdate.forwardProxyInput ● ForwardProxyInput! non-null input platform

Type

ForwardProxy object platform

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

On this Page