Using the cf CLI with a Proxy Server

Page last updated:

If you have an HTTP or SOCKS5 proxy server on your network between a host running the cf CLI and your Cloud Foundry API endpoint, you must set https_proxy with the hostname or IP address of the proxy server.

The https_proxy environment variable holds the hostname or IP address of your proxy server.

https_proxy is a standard environment variable. Like any environment variable, the specific steps you use to set it depends on your operating system.

Format of https_proxy

https_proxy is set with hostname or IP address of the proxy server in URL format: https_proxy=

If the proxy server requires a user name and password, include the credentials: https_proxy=

If the proxy server uses a port other than 80, include the port number: https_proxy=

If the proxy server is a SOCKS5 proxy, specify the SOCKS5 protocol in the URL: https_proxy=socks5://

Using SOCKS5 with v3-ssh

The cf v3-ssh command supports SOCKS5 proxies. To specify the SOCKS5 proxy server, set the ALL_PROXY environment variable using the following format: ALL_PROXY=socks5://

Note: cf ssh does not work through a SOCKS5 proxy.

Setting https_proxy in Mac OS or Linux

Set the https_proxy environment variable using the command specific to your shell. For example, in bash, use the export command.


$ export https_proxy=

To make this change persistent, add the command to the appropriate profile file for the shell. For example, in bash, add a line like the following to your .bash_profile or .bashrc file:

  export $https_proxy

Setting https_proxy in Windows

  1. Open the Start menu. Right-click Computer and select Properties.


  2. In the left pane of the System window, click Advanced system settings.

    Adv settings

  3. In the System Properties window, select the Advanced tab, then click Environment Variables.

    Env var

  4. In the Environment Variables window, under User variables, click New.


  5. In the Variable name field, input https_proxy. In the Variable value field, input your proxy server information.


  6. Click OK.

Create a pull request or raise an issue on the source for this page in GitHub