Skip to content

Install First Agent

SaaS Deploy a SentriKat agent to start collecting software inventory.

Time: ~5 minutes

What Does an Agent Do?

A SentriKat agent runs on your endpoint (server, workstation, or VM), scans installed software, and reports back to the SaaS platform. SentriKat then matches your inventory against the CISA KEV catalog and other vulnerability databases.

Agents are lightweight and run as a scheduled task or systemd timer — they don't use a persistent daemon.

Generate an API Key

Before installing an agent, you need an API key:

  1. Go to Settings > API Keys
  2. Click + New Key
  3. Choose a Key Type:
    • Server — for servers, VMs, cloud instances
    • Client — for workstations, laptops
  4. Copy the generated key — you'll need it during installation

Key Types

The key type affects how vulnerabilities are prioritized on the dashboard. Server vulnerabilities are weighted higher than client-side ones.

Choose Your Platform

Requirements: Windows 10/11 or Server 2016+, PowerShell 5.1+

  1. Download the agent from Settings > Downloads or run: 

    Invoke-WebRequest -Uri "https://app.sentrikat.com/downloads/agent/windows" -OutFile sentrikat-agent.exe

  2. Install with your API key: 

    .\sentrikat-agent.exe install --api-key YOUR_API_KEY --url https://app.sentrikat.com

  3. Run the first scan: 

    .\sentrikat-agent.exe scan

The agent registers as a Windows Scheduled Task and runs every 6 hours by default.

Requirements: Ubuntu 20.04+, Debian 11+, RHEL 8+, or any systemd-based distro

  1. Download and install: 

    curl -fsSL https://app.sentrikat.com/downloads/agent/linux -o sentrikat-agent
chmod +x sentrikat-agent
sudo mv sentrikat-agent /usr/local/bin/

  2. Configure: 

    sudo sentrikat-agent install --api-key YOUR_API_KEY --url https://app.sentrikat.com

  3. Run the first scan: 

    sudo sentrikat-agent scan

The agent registers as a systemd timer and runs every 6 hours by default.

Requirements: macOS 12 (Monterey) or later

  1. Download and install: 

    curl -fsSL https://app.sentrikat.com/downloads/agent/macos -o sentrikat-agent
chmod +x sentrikat-agent
sudo mv sentrikat-agent /usr/local/bin/

  2. Configure: 

    sudo sentrikat-agent install --api-key YOUR_API_KEY --url https://app.sentrikat.com

  3. Run the first scan: 

    sudo sentrikat-agent scan

The agent registers as a launchd job and runs every 6 hours by default.

Verify the Agent

After the first scan completes:

  1. Go to your SentriKat dashboard
  2. Navigate to Products — you should see software inventory appearing
  3. The agent shows up under Settings > Agents with a "Last seen" timestamp

First Scan Takes a Moment

The first scan may take 1–2 minutes depending on how much software is installed. Subsequent scans are faster because only changes are reported.

Troubleshooting

Symptom Fix
Agent says "Unauthorized" Check your API key — copy it again from Settings > API Keys
No products appear after scan Wait 2–3 minutes, then refresh the Products page
Agent can't reach the server Check firewall/proxy — the agent needs HTTPS access to app.sentrikat.com:443

For detailed agent docs, see Agents Overview.

Next Step

Run your first scan