Network proxy configuration

A network proxy acts as an intermediary server, routing requests from Apidog to internet resources while safeguarding your internal network.

• The Default Proxy Configuration manages how Apidog connects to the internet and sends API requests.
• The API Request Proxy Configuration is specific to API requests and can be customized independently to use either the default settings or a custom setup.

If your proxy requires authentication, enter the necessary details under Settings > Network Proxy, accessible from the lower-left corner of the Apidog interface.

Both proxy settings offer a default option of Do Not Use Proxy, with the API configurations set to Use Default Configuration initially.

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.

:::tip[]
To incorporate the HTTP_PROXY, HTTPS_PROXY, and NO_PROXY environment variables from your system into Apidog, enable the following option:

:::

Specific Proxy Configuration

Configure Custom Proxy

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.

Authentication Process

For proxies requiring credentials, provide the username and password under Settings - Network Proxy. Ensure you turn on the Authentication feature under the chosen proxy configuration, either System Proxy or Custom, then click Save and Restart Apidog.

Proxy Setup During Login

You can configure the Network Proxy directly from the login screen if a proxy is essential for accessing Apidog.