Documentation

Last updated: April 24, 2026

ANTIV Documentation

Welcome to the ANTIV technical documentation. Use the sections below to find guides, API references, and integration tutorials for the platform.

Getting Started

Desktop Agent (Windows & Linux)

Installation

Download the ANTIV desktop agent installer from your client dashboard under Downloads. The installer bundles ClamAV and all required dependencies.

  • Supported platforms: Windows 10/11, Windows Server 2016+, Ubuntu 20.04+, Debian 11+, RHEL 8+
  • The agent registers automatically using your account's registration token
  • After installation, the device appears in your portal dashboard within 60 seconds

Configuration

The agent reads configuration from config.ini located in the application directory. Key settings:

  • [portal] url — Portal URL (default: https://antiv.io)
  • [scan] local_exclusions — Semicolon-separated paths to exclude from all scans
  • [email] — SMTP settings for the email protection proxy

Linux Server Agent (v2.0)

The Linux Server Security Agent provides a full security centre for Linux servers, including:

  • ClamAV antivirus scanning with portal-initiated and scheduled scans
  • Firewall management (iptables/nftables rules via portal)
  • Intrusion detection (fail2ban integration)
  • Rootkit detection (rkhunter)
  • File integrity monitoring (FIM)
  • Real-time process and network monitoring
  • Backup and restore management
  • SSL certificate expiry monitoring
  • Kernel and security patch management

REST API

The ANTIV API allows programmatic access to scanning, device management, and reporting. The API base URL is /api/v1/.

Authentication

API requests are authenticated using device registration keys passed in the X-Device-Key header, or with bearer tokens for user-level access.

Key Endpoints

  • POST /api/v1/scan — Initiate an on-demand file or URL scan
  • GET /api/v1/scan/{scanId}/status — Poll scan status
  • POST /api/device/{key}/heartbeat — Agent heartbeat and exclusion sync
  • POST /api/device/{key}/scan-result — Submit scan results from agent

MSP Partner Documentation

MSP partners have access to an extended documentation set covering multi-tenant management, policy templates, group operations, and partner reporting. Visit the MSP Getting Started Guide to begin.

Support

Can't find what you're looking for? Reach out to our support team at support@antiv.io or open a ticket from your dashboard.