Skip to main content

Network Proxy

This article will guide you configuring network proxy in Apidog.

A network proxy is an intermediary server between Apidog and the server. A proxy server acts as a security barrier, representing you to make requests to websites and other internet resources, and preventing others from accessing your internal network.

  • By default, Apidog uses the default proxy configuration to send API requests or access the internet.

  • The default proxy configuration applies to all networked services, including connecting to the Apidog server and sending API requests.

  • The API request proxy configuration applies only to sending API requests, not to connecting to the Apidog server, and can be configured separately for Apidog to use the default proxy configuration or custom configuration when sending requests.

  • If your system's configured proxy requires authentication, you can enter the corresponding authentication information in Settings - Network Proxy in the lower left corner of the page.

The default proxy configuration defaults to Do Not Use Proxy; the API request proxy configuration defaults to Use Default Configuration.

Default Proxy Configuration​

  1. The default proxy configuration applies to all networked services, including connecting to the Apidog server and sending API requests. The default is Do Not Use Proxy.

  2. If you have configured a proxy for your local system, you can set the default proxy configuration in Apidog to Use System Proxy.

  3. Configuring a custom proxy is also supported.

API Request Proxy Configuration​

  1. If the API request proxy configuration is set to Use Default Configuration, then the API request proxy configuration will be the same as the default proxy configuration.

  2. To use the system proxy to send API requests, set the default proxy configuration to Use System Proxy and the API request proxy configuration to Use Default Configuration.

Note

If you want Apidog to use the HTTP_PROXY, HTTPS_PROXY, NO_PROXY environment variables configured in your operating system, check the option below:

Specific Proxy Configuration​

Configure Custom Proxy​

Configure a custom proxy to use a proxy server other than the system proxy to send API requests. You can send HTTP requests, HTTPS requests, or both types of requests through the custom proxy.

  • API Type: Choose the type of requests to send through the proxy server. HTTP and HTTPS are checked by default.

  • Proxy Server: Input the hostname or IP address and port number of the proxy server. (Do not include the protocol before the hostname or IP address)

  • Bypass: Input a comma-separated list of hosts that requests to those hosts will not use the custom proxy.

  • Authentication: If the proxy server requires authentication, turn on this switch and input the proxy server's username and password.

Authentication​

If your system's configured proxy server requires authentication, input the identity information in Apidog. In Settings - Network Proxy in the lower left corner, under Default Proxy Configuration for System Proxy or Custom, turn on Authentication, input the Username and Password required by the proxy server, then select Save and Restart Apidog.

Set Network Proxy When Logging In​

If a proxy server is already enabled before logging in, you can set up the Network Proxy in the login screen.