Skip to content

Scan Agent Setup Guide

This guide covers the installation, configuration, and management of the RADAR Security scan agent for Windows environments.

Quick Start

  1. Download the scan agent package for Windows
  2. Extract to your desired installation directory
  3. Download the setup script: scan_install.bat
  4. Run scan_install.bat as Administrator
  5. Configure API credentials
  6. Agent starts automatically when any user logs in

Downloads

Required Scripts

Installation Package

  • Download scan_agent_1.5.4_Windows_x86_64.zip from your RADAR Security dashboard
  • Extract to your desired installation directory

Prerequisites

  • Windows 10/11 or Windows Server 2016+
  • Administrator privileges for installation
  • API Key from your RADAR Security dashboard
  • Network access to your target assets and app.radarsecurity.ai

Installation

  1. Download scan_agent_1.5.4_Windows_x86_64.zip (or arm64 for ARM-based systems)
  2. Extract the contents to C:\Program Files\RADAR Security\ or your preferred directory
  3. Download the setup script: scan_install.bat and place it in the same directory as scan_agent.exe
  4. Right-click scan_install.bat and select "Run as administrator"

Installation Steps

The installer will prompt you for:

  1. API URL: Enter https://app.radarsecurity.ai/api/agent
  2. API Key: Paste your API key from the RADAR dashboard

The agent will be configured to: - Start automatically when any user logs in - Run continuously until manually stopped - Run with user privileges for better compatibility

What Gets Configured

  • User Login Task: "ScanAgent" runs when any user logs in
  • Configuration File: start_agent.bat with your API settings
  • User Account: Runs with user privileges for better compatibility
  • Continuous Operation: Agent runs until manually stopped

Manual Configuration

If you prefer manual setup or the automated installer fails:

1. Environment Variables

Set your API credentials as environment variables:

setx API_KEY "your-api-key-here" /M
setx API_URL "https://app.radarsecurity.ai/api/agent" /M

2. Create User Login Task

schtasks /create /tn "ScanAgent" /tr "\"C:\path\to\start_agent.bat\"" /sc onlogon /rl highest /f

3. Manual Start

start_agent.bat

Starting and Stopping

Manual Control

# Start the agent manually
start_agent.bat

# Stop with Ctrl+C in the console
# Or kill the process:
taskkill /f /im scan_agent.exe

Automatic Management

The agent starts automatically when any user logs in. Use Task Scheduler to manage:

# Check status
schtasks /query /tn "ScanAgent"

# Disable temporarily
schtasks /change /tn "ScanAgent" /disable

# Re-enable
schtasks /change /tn "ScanAgent" /enable

Verification

Check Agent Status

# Verify process is running
tasklist /fi "imagename eq scan_agent.exe"

# Check scheduled task
schtasks /query /tn "ScanAgent"

Monitor Activity

  • Check your RADAR Security dashboard for scan results
  • Agent sends heartbeat every 5 minutes
  • Agent runs continuously once started

Troubleshooting

Common Issues

"Access denied" when creating scheduled task: - Run scan_install.bat as Administrator - Check User Account Control settings

Agent won't start: - Verify API credentials are correct - Check network connectivity to app.radarsecurity.ai - Ensure no firewall blocking outbound connections

Agent not starting at login: - Confirm user login task exists in Task Scheduler - Check if task is enabled and set to run on logon - Verify agent has necessary permissions - Try logging out and logging back in

Logs and Diagnostics

The agent logs to console output. For background operation:

# View running tasks
tasklist /v /fi "imagename eq scan_agent.exe"

# Check Windows Event Viewer
# Application logs may contain additional information

Uninstallation

Complete Removal

Download and run the uninstaller script:

  1. Download: uninstall_agent.bat
  2. Place it in the same directory as your scan agent installation
  3. Run the script:
uninstall_agent.bat

This will: - Stop any running agent processes - Remove the scheduled task - Delete generated configuration files - Clean up log files

Manual Cleanup

If uninstaller fails:

# Kill processes
taskkill /f /im scan_agent.exe

# Remove scheduled task
schtasks /delete /tn "ScanAgent" /f

# Remove files
del start_agent.bat
del *.log

Configuration Files

scan_install.bat

  • Interactive installer script
  • Prompts for API configuration
  • Creates user login task and start script

start_agent.bat

  • Generated by installer
  • Contains your API credentials
  • Starts agent continuously

uninstall_agent.bat

  • Complete removal script
  • Safe cleanup of all components

Network Requirements

  • Outbound: Allow connections to app.radarsecurity.ai (HTTPS)
  • Inbound: Agent listens on localhost only
  • Firewall: No inbound rules required
  • Proxy: Configure system proxy if needed

Security Considerations

  • API Key: Store securely, treat like a password
  • Permissions: Agent runs with high privileges for scanning
  • Network: Limit agent network access to necessary systems
  • Updates: Agent checks for updates automatically

Support

For issues not covered here:

  1. Check the RADAR Documentation
  2. Review settings.md and internal.md for advanced configuration
  3. Contact RADAR support with agent logs and error messages

Version: 1.5.4 Last Updated: October 6, 2025