Features

Interceptor

Intercept and modify requests and responses.

You can access APIs blocked by Cross-Origin Resource Sharing (CORS) restriction by using either Hoppscotch Agent, Proxyscotch or custom middleware. You can also use the Hoppscotch web extension to intercept requests and responses.

ProxyA proxy server acts as an intermediary between your device and the internet, forwarding requests and responses to and from the desired API. By routing requests through a proxy, you can bypass CORS restrictions and access APIs that would otherwise be blocked by the browser.* Enable proxy interceptor fromSettings pageInterceptorssection.

You can replace the default Proxy URL with your own proxy middleware if you wish or use Proxyscotch, which acts as a remote proxy server for routing API requests.## ProxyscotchProxyscotch is our official proxy server. It is an MIT licensed open-source project that can bypass Cross-Origin Resource Sharing (CORS) restrictions by routing API requests through a remotely hosted proxy, ensuring that requests originate from a trusted environment.#### Self-Hosted ProxyscotchTo use Proxyscotch with a minimal setup, you can pull and run the official pre-built Docker image. This provides an instant proxy environment without requiring manual compilation or installation. You can host Proxyscotch on your own server by following the instructions below:```bash

Pull the latest Proxyscotch image from Docker Hub

docker pull hoppscotch/proxyscotch

Run the container in detached mode, exposing port 9159

docker run -d -p 9159:9159 --name proxyscotch hoppscotch/proxyscotch

Proxyscotch InstallerIf you prefer a native installation, download and install both the Desktop and Server binaries for your operating system.:::callout

The proxy will add a **desktop application to your system tray**, providing quick access to various proxy settings such as setting the access token. After launching the application, a dialog will prompt you to complete the **certificate installation** process. For more details on how to install the certificate, [visit this wiki](https://github.com/hoppscotch/proxyscotch/wiki/Certificate-Installation).Upon activation, the **server** will run in the background and interact with the proxy to route and manage requests.
:::### Building Proxyscotch from SourceIf you prefer to build and run Proxyscotch manually from source, you can clone the repository and compile the binaries for your platform.```bash
git clone https://github.com/hoppscotch/proxyscotch.git 
```Follow the platform-specific instructions below to build the proxy and server from source for your operating system:<!-- AccordionGroup component not supported -->:::callout{kind="tip"}
 After building, the compiled binaries will be available in the `out/` directory. 
:::#### Running the Proxyscotch ServerAfter building the server, use the following command to start the proxy server:```bash
$ ./out/<platform>-server/server --host="<hostname>:<port>" --token="<token_or_blank>"

# e.g. on Linux
$ ./out/linux-server/server --host="localhost:9159" --token=""

# or on Windows
$ ./out/windows-server/server.exe --host="localhost:9159" --token=""
```:::callout{kind="warning"}
 When the **token is left blank**, it grants unrestricted access to your proxy server. While this might be convenient, please be aware of the potential security risks and consider whether this level of open access is appropriate for your use case. 
:::#### Available Server OptionsAfter running the Proxyscotch server, you can customize its behavior using various command-line options.| **Option**                    | **Description**                                                            |
| ----------------------------- | -------------------------------------------------------------------------- |
| `--host="<hostname>:<port>"`  | Define the host and port (default: `localhost:9159`).                      |
| `--token="<token>"`           | Set an access token to restrict proxy usage (leave blank for open access). |
| `--allowed-origins="*"`       | Comma-separated list of allowed origins for CORS.                          |
| `--banned-outputs="<values>"` | Comma-separated list of response values to redact.                         |
| `--banned-dests="<hosts>"`    | Comma-separated list of blocked destination hosts.                         |### Configure Proxyscotch in HoppscotchOnce the container is running or the server is active, configure Hoppscotch to use `http://localhost:9159` as the Proxy URL in the "**Settings**" page.This setup will route all API requests through Proxyscotch, facilitating communication with APIs that enforce strict CORS policies.

Code Snippets Context Menu

Built with

Show your support! Star us on GitHub ⭐️

Star

The proxy will add a **desktop application to your system tray**, providing quick access to various proxy settings such as setting the access token. After launching the application, a dialog will prompt you to complete the **certificate installation** process. For more details on how to install the certificate, [visit this wiki](https://github.com/hoppscotch/proxyscotch/wiki/Certificate-Installation).Upon activation, the **server** will run in the background and interact with the proxy to route and manage requests.

:::### Building Proxyscotch from SourceIf you prefer to build and run Proxyscotch manually from source, you can clone the repository and compile the binaries for your platform.```bash

git clone https://github.com/hoppscotch/proxyscotch.git

```Follow the platform-specific instructions below to build the proxy and server from source for your operating system::::callout{kind="tip"}

After building, the compiled binaries will be available in the `out/` directory.

:::#### Running the Proxyscotch ServerAfter building the server, use the following command to start the proxy server:```bash

$ ./out/<platform>-server/server --host="<hostname>:<port>" --token="<token_or_blank>"

# e.g. on Linux

$ ./out/linux-server/server --host="localhost:9159" --token=""

# or on Windows

$ ./out/windows-server/server.exe --host="localhost:9159" --token=""

```:::callout{kind="warning"}

When the **token is left blank**, it grants unrestricted access to your proxy server. While this might be convenient, please be aware of the potential security risks and consider whether this level of open access is appropriate for your use case.

:::#### Available Server OptionsAfter running the Proxyscotch server, you can customize its behavior using various command-line options.| **Option** | **Description** |

| ----------------------------- | -------------------------------------------------------------------------- |

| `--host="<hostname>:<port>"` | Define the host and port (default: `localhost:9159`). |

| `--token="<token>"` | Set an access token to restrict proxy usage (leave blank for open access). |

| `--allowed-origins="*"` | Comma-separated list of allowed origins for CORS. |

| `--banned-outputs="<values>"` | Comma-separated list of response values to redact. |

| `--banned-dests="<hosts>"` | Comma-separated list of blocked destination hosts. |### Configure Proxyscotch in HoppscotchOnce the container is running or the server is active, configure Hoppscotch to use `http://localhost:9159` as the Proxy URL in the "**Settings**" page.This setup will route all API requests through Proxyscotch, facilitating communication with APIs that enforce strict CORS policies.