MaxRMM Documentation
Everything you need to deploy, configure, and manage MaxRMM across your endpoints.
Getting Started
New to MaxRMM? Start here to get your first agent deployed in under five minutes.
- Quick Start — Sign up, generate an install key, deploy your first agent, and see telemetry in the dashboard.
- System Requirements — Supported operating systems, .NET and PowerShell versions, and network requirements.
Agent Installation
Detailed guides for installing, configuring, and troubleshooting the MaxRMM agent on Windows endpoints.
- Installing the Agent — PowerShell one-liner, manual install, and silent deployment flags.
- Agent Configuration — Registry keys for report interval, log level, and watched services.
- Uninstalling the Agent — Clean removal commands and manual cleanup steps.
- Agent Troubleshooting — Common issues, log locations, and rollback procedures.
Dashboard Guide
Learn how to use every section of the MaxRMM dashboard to manage your fleet.
- Dashboard Overview — Navigation, sections, and what each panel shows.
- Managing Agents — Agent detail, remote connect, terminal, and command execution.
- Alerts & Alert Rules — Creating rules, severity levels, maintenance mode, and alert snoozing.
- Patch Management — Policies, maintenance windows, compliance scanning, and manual installs.
- Automation — Scripts, scheduled execution, event triggers, healing rules, and workflows.
- Ticketing — Creating tickets, templates, SLA policies, contracts, and invoices.
- Security Scores — What each check means, how scoring works, and compliance mapping.
- Reports — Report types, scheduling, and CSV/PDF export.
API Reference
Integrate MaxRMM with your own tools using the REST API.
- API Authentication — JWT tokens, refresh flow, and Bearer header format.
- API Endpoints — Complete endpoint reference grouped by resource.
Integrations
Connect MaxRMM to Slack, Microsoft Teams, and email for automated notifications and ticket creation.
- Slack Integration — Webhook setup and notification configuration.
- Microsoft Teams — Incoming webhook setup and adaptive cards.
- Email-to-Ticket — Configure inbound email to automatically create and update tickets.