--- title: "Quickbase Pipelines Agent Client Installation" slug: "quickbase-pipelines-agent-client-installation" updated: 2026-06-02T13:34:06Z published: 2026-06-02T13:34:06Z canonical: "help.quickbase.com/quickbase-pipelines-agent-client-installation" --- > ## Documentation Index > Fetch the complete documentation index at: https://help.quickbase.com/llms.txt > Use this file to discover all available pages before exploring further. # Quickbase Pipelines Agent Client Installation Before you install the Pipelines Agent Client, check your permissions and access. ### Permissions and access Before you begin this process, make sure your network allows: - DNS lookups to hosts 'agents.pipelines.quickbase.com' and 'www.pipelines.quickbase.com' - outbound TCP connections to TCP port 5555 for 'agents.pipelines.quickbase.com' protocol CurveZMQ - regular HTTPS on port 443 for 'www.pipelines.quickbase.com' To achieve this, you will need to enable outgoing connections to Cloudflare IPs. For a full list of IP ranges, see: [IP Ranges | Cloudflare](https://www.cloudflare.com/ips/) #### Windows access Contact your IT group to verify you have the correct Windows privileges. You will need this access to get started: - Write access to Windows Temp directory for the Agent Client installation files - Admin access to Windows to be able to perform the installation We recommend using a separate Quickbase user dedicated to connect to the On-Premises agent. ## Start the Agent installation process You enable the Agent by opening **Pipelines > My Preferences > Agent** tab. Select the **Agent on** toggle. ![Pipelines My Preferences page open to the Agent tab](https://cdn.document360.io/dd260e4e-10bb-4b66-8fb3-5504c272b904/Images/Documentation/4495923418132.png) ![Agent tab showing three agent setup steps](https://cdn.document360.io/dd260e4e-10bb-4b66-8fb3-5504c272b904/Images/Documentation/9985256001172.png) Follow the instructions on the Agent tab. When you enable the agent three steps display: - **Step 1: Download agent** — This step has a link to download the agent on your machine. When you select **Click to download**, the download begins. To copy the link to install on another device, select **Copy link**. - **Step 2: Configure and start agent** — This step turns on the agent and provides the settings you will need during the installation process of the agent on your machine. **Note:** If you turn off the agent, these settings refresh, which means you should repair the agent installation if you accidentally stop and start the agent from the settings page, as the token (which gets refreshed) is given to the agent on installation time and the agent will stop working immediately. If for some reason you lose control of a machine with an installed agent, this is the way to revoke its access remotely. - **Step 3: Verify status** — This step checks to see if the agent is running successfully or not. If the status is successful, you receive detailed data about your connection to the Agent. ### What is bundled in the agent installer? Your installation download, the MSI file, contains these files: 1. Windows Service - `QuickbasePipelinesAgentService.exe` This is a windows background service, which runs the agent and is for production use. 2. Interactive application - `QuickbasePipelinesAgentInteractive.exe` This provides a way to run the agent for debugging purposes. 3. Open source software used by the agent ## Installation Follow these steps to install Pipelines Agent Client. 1. From Windows start the installer by double-clicking the file you downloaded from the Agent tab. The welcome screen displays: ![Pipelines Agent installer welcome screen](https://cdn.document360.io/dd260e4e-10bb-4b66-8fb3-5504c272b904/Images/Documentation/4495950674836.png) 2. Enter the API Token and Host and select **Next**. You can copy these from the Agent tab. ![Pipelines Agent installer with API Token and Host fields](https://cdn.document360.io/dd260e4e-10bb-4b66-8fb3-5504c272b904/Images/Documentation/4495923049876.png) 3. Select the checkbox to accept the End-User License Agreement and select **Next**. ![Pipelines Agent installer End-User License Agreement screen](https://cdn.document360.io/dd260e4e-10bb-4b66-8fb3-5504c272b904/Images/Documentation/4495923126804.png) 4. Choose where to install the Quickbase Pipelines Agent Client. Either enter the destination path manually or select **Change** to select a different location. Select **Next** to continue. ![Pipelines Agent installer destination folder selection screen](https://cdn.document360.io/dd260e4e-10bb-4b66-8fb3-5504c272b904/Images/Documentation/4495944226580.png) 5. Select **Install** to begin the installation of the Quickbase Pipelines Agent. It will be started as a Windows Service (in Automatic mode). You may be prompted by Windows. Select **Yes** and the installation will begin. ![Pipelines Agent installer ready to install screen](https://cdn.document360.io/dd260e4e-10bb-4b66-8fb3-5504c272b904/Images/Documentation/4495950775572.png) ![Windows User Account Control prompt for Pipelines Agent installation](https://cdn.document360.io/dd260e4e-10bb-4b66-8fb3-5504c272b904/Images/Documentation/4495950959636.png) ![Pipelines Agent installation progress screen](https://cdn.document360.io/dd260e4e-10bb-4b66-8fb3-5504c272b904/Images/Documentation/4495829985300.png) 6. When the installation finishes, this window displays. Select **Finish** and the installer closes. ![Pipelines Agent installer completion screen with Finish button](https://cdn.document360.io/dd260e4e-10bb-4b66-8fb3-5504c272b904/Images/Documentation/4495944362900.png) 7. When the installation is finished, you can return to the Agent tab to check if the Quickbase Pipelines Agent is connected successfully: ![Agent tab showing successful Pipelines Agent connection status](https://cdn.document360.io/dd260e4e-10bb-4b66-8fb3-5504c272b904/Images/Documentation/4495923270292.png) ## Repair/Remove When the Quickbase Pipelines Agent Client is already installed and you need to repair or remove the installation, double-click the file you downloaded from the Agent tab, and these options display: ![Pipelines Agent installer repair or remove options screen](https://cdn.document360.io/dd260e4e-10bb-4b66-8fb3-5504c272b904/Images/Documentation/4495936469140.png) ### Repair When you select **Repair**, you repeat the installation again. You will be prompted to supply the API token and host. The installer will reinstall the Quickbase Pipelines Agent Client with any changes you have made. ### Remove When you select **Remove**, you can completely delete the Quickbase Pipelines Agent. The Windows Service will be stopped and removed. All the installed files will be deleted. ![Pipelines Agent installer removal confirmation screen](https://cdn.document360.io/dd260e4e-10bb-4b66-8fb3-5504c272b904/Images/Documentation/4495944446228.png) You may be prompted to restart.