Documentation hub

Everything the platform does, how each part is used, and what it does when something goes wrong. Start with Getting started for the end-to-end walkthrough, or jump straight to the area you are working in.

Start here

Getting startedFrom sign-in to your first AI-remediated ticketSet up OrcaMonitor end to end: create your workspace, sign in, tour the dashboard, add your first device, connect a monitoring source, and watch the agent resolve a ticket with your approval.8 min readRead

Day-to-day operations

Devices & inventoryOne record per asset, with reachability you can trustManage the OrcaMonitor device inventory: add devices, store credentials in Vault, run discovery, read the health score, take configuration backups, and act at fleet scale.7 min readRead Alerts & correlationEvery source, one incident, less noiseIngest alerts from Zabbix, LibreNMS, Nagios, PRTG, Splunk and cloud APIs, correlate them into a single incident, acknowledge with comments, and see how alert-derived tickets are opened and closed.6 min readRead Tickets & automationThe lifecycle, the approval gate, and what happens when it failsThe OrcaMonitor ticket lifecycle end to end: how tickets are created, how the agent plans and executes, the approval gate, objective verification, cancellation, budgets, and the states operators see.9 min readRead Network & connectivityRoute private IPs in, and diagnose tunnels across vendorsConnect OrcaMonitor to private networks over WireGuard or IPsec, allow the office through the cloud firewall, and diagnose VPN tunnels across FortiGate, Cisco, Juniper, Palo Alto and MikroTik.8 min readRead Observability & analysisMetrics, streaming telemetry, offline config analysis and packetsQuery Prometheus with PromQL, stream telemetry over gNMI and NETCONF, analyse configurations offline with Batfish, and inspect captures with Packet Buddy — all read-only and agent-accessible.7 min readRead

Automation & AI

AI agentsAgent Chat, ticket remediation, tools and meteringHow OrcaMonitor's AI works: Agent Chat for live operations, ticket remediation for incidents, the MCP tool catalog the agent can call, model configuration, and how AI usage is metered and capped.10 min readRead

Integrations

IntegrationsMonitoring sources, clouds, hypervisors and notificationsConnect OrcaMonitor to Zabbix, LibreNMS, Nagios, PRTG, Splunk, Meraki, Proxmox, vSphere, UniFi, Cisco ISE, AWS, Azure, GCP and Prometheus, plus email, Slack and Teams notifications.11 min readRead

Administration

RBAC, approvals & auditWho can do what, who approved it, and where the proof livesRole-based access control with page-scoped permissions, a permission catalogue you can reason about, approval policy for mutating actions, and an append-only, tamper-evident audit trail.8 min readRead Deployment & licensingCloud, on-prem or hybrid — and how updates reach youDeploy OrcaMonitor as managed cloud, on-premises or hybrid. Understand the console, instance and agent split, licensing and device limits, and how updates reach an installed instance.9 min readRead

Reference

API & MCP referenceREST endpoints and the MCP tool surface the agent usesOrcaMonitor's REST API for devices, alerts, tickets and automation, plus the MCP tool endpoints that expose the same capabilities to AI agents over Streamable HTTP with JSON-RPC.8 min readRead Security & data protectionSecrets, isolation, and the safety model around automationHow OrcaMonitor protects credentials and data: Vault-backed secret storage, workspace isolation, the sandbox for agent-authored code, approval-gated tool calls, and compliance evidence export.7 min readRead Troubleshooting & FAQThe failures that actually happen, and how to read themDiagnose common OrcaMonitor problems: devices offline while actually up, tickets stuck in Verifying fix, undelivered mail, missing agent tools, AI paused by a credit cap, and failed updates.9 min readRead

Quick links

Add your first deviceCredentials, test connection and discovery The ticket lifecycleStates, the approval gate and verification Approval & auditWho approved what, and where the proof is MCP endpointsEvery tool endpoint and how to call one TroubleshootingThe failures that actually happen

Need help?

If you cannot find what you are looking for, contact the team. Include your instance, the affected ticket or device id, and a timestamp — for anything the agent did, that is usually enough to answer it without reproducing.

Looking for a short answer instead of a guide? The troubleshooting page covers the failures that come up most.

New here?

Start with Getting started and follow it through to a resolved ticket. It takes about ten minutes and covers the whole product once.

Start the tour

13 sections · documentation v1.0.0

OrcaMonitor documentation v1.0.0 · Report a problem

Explore the full platform

See every module, pricing tier, and deployment option on the OrcaMonitor overview.

Back to Overview