A network proxy acts as an intermediary server, routing requests from Apidog to internet resources while safeguarding your internal network. Apidog provides flexible proxy configuration options to accommodate different network environments and security requirements.Proxy Configuration Types#
Default Proxy Configuration: Manages how Apidog connects to the internet and sends API requests
API Request Proxy Configuration: Specific to API requests and can be customized independently to use either the default settings or a custom setup
Default Proxy Configuration#
1.
The default proxy includes all network services related to Apidog such as server connection and API requests, with the initial setting of Do Not Use Proxy.
2.
If your local system uses a proxy, set Apidog's default proxy to Use System Proxy.
3.
You can also configure a Custom Proxy if needed.
API Request Proxy Configuration#
1.
If set to Use Default Configuration, API requests will mirror the default proxy settings.
2.
For API requests to use the system proxy settings, ensure both default and API proxy settings are appropriately linked.
To incorporate the HTTP_PROXY, HTTPS_PROXY, and NO_PROXY environment variables from your system into Apidog, enable the following option:π· Visual Reference
Specific Proxy Configuration#
For using a different proxy server from the system settings for API requests, configure a custom proxy. You have the flexibility to route HTTP, HTTPS, or both types of requests through the custom proxy.API Type: Define if HTTP, HTTPS, or both are routed via the proxy
Proxy Server: Input the hostname or IP and port number
Bypass: List the hosts that should bypass the proxy
Authentication: If needed, enable this option and provide the username and password for the proxy
π· Visual Reference
Authentication Process#
For proxies requiring credentials, provide the username and password under Settings β Network Proxy.1.
Enable the Authentication feature under the chosen proxy configuration (either System Proxy or Custom)
3.
Click Save and Restart Apidog
π· Visual Reference
Proxy Setup During Login#
You can configure the Network Proxy directly from the login screen if a proxy is essential for accessing Apidog.If you're behind a corporate firewall or VPN, consult your IT department for the correct proxy settings to use with Apidog.
