Documentation

Everything you need to get started with VaultMate and make the most of our platform.

Quick Start Guide

Get up and running in under 10 minutes with our step-by-step guide.

Read Guide
Agent Installation

Learn how to install and configure the Windows agent on your devices.

View Instructions
API Reference

Integrate VaultMate with your existing tools using our REST API.

Explore API

Quick Start Guide

1
Create Your Account

Sign up for a free trial at vaultmate.io/signup. No credit card required.

2
Download the Agent

After logging in, go to Agent Setup to download the Windows agent installer.

3
Install on Your Devices

Run the installer on each Windows device you want to scan. Enter your Organization Key when prompted.

4
Configure Scan Locations

In the dashboard, set up which directories should be scanned for sensitive data.

5
Run Your First Scan

The agent will automatically scan according to your schedule, or you can trigger a manual scan.

6
Review Reports

View scan results in the dashboard and download PDF/Excel reports for compliance documentation.

Agent Installation

System Requirements
  • Windows 10 or Windows 11 (64-bit)
  • Windows Server 2016 or later
  • Minimum 100 MB available disk space
  • Internet connection for API communication
  • Administrator privileges for installation
Installation Steps
  1. Download the agent from your dashboard (Agent Setup page)
  2. Right-click the installer and select "Run as Administrator"
  3. Enter your Organization Key when prompted
  4. Choose installation directory (default: C:\Program Files\VaultMate)
  5. The agent will install as a Windows service and start automatically
Configuration

The agent configuration is managed from the VaultMate dashboard. You can configure:

  • Directories to scan
  • Scan schedule (hourly, daily, weekly)
  • File type filters
  • Exclusion patterns

API Reference

VaultMate provides a REST API for integrating with your existing tools and workflows. All API endpoints require authentication using your device token.

Base URL
https://api.vaultmate.io/v1
Authentication

Include your device token in the Authorization header:

Authorization: Token your_device_token_here
Available Endpoints
Method Endpoint Description
POST /agent/register/ Register a new device
GET /agent/config/ Get device configuration
POST /agent/scan-results/ Submit scan results
POST /agent/upload-report/ Upload PDF/Excel reports
POST /agent/heartbeat/ Send device heartbeat

Need More Help?

Can't find what you're looking for? Our support team is here to help.

Help Center Contact Support