Portal

Vistralio — API Reference

This is the current runtime API surface for build `0.1.8 (Beta) Build 20260420.1`.

Updated 24 Jun 2026 · 10 views

Vistralio External Security Test

Date: 2026-04-14 Target build: `0.1.0 (Beta) Build 20260414.3` Test style: black-box external testing from the host, focused on publicly reachable HTTP surfaces and authentication boundaries

Updated 24 Jun 2026 · 5 views

Vistralio Security Review

Date: 2026-04-14 Build reviewed: `0.1.0 (Beta) Build 20260414.3`

Updated 24 Jun 2026 · 7 views

Recordings & export

How Vistralio stores video, how long it keeps it, how to review it in the dedicated playback page, and how to get it out.

Updated 24 Jun 2026 · 6 views

Updates & upgrades

Vistralio now ships with a dedicated update subsystem.

Updated 24 Jun 2026 · 5 views

Contractors / Vendors

The platform supports external **contractors and vendors** (subcontractors, freelancers, suppliers) who get their own dedicated portal at `/vendors`. They sign in via a separate `/vendor-login` URL, see only what's been explicitly assigned

Updated 24 Jun 2026 · 5 views

Admin · Helpdesk & CRM config

Admin pages that control helpdesk behaviour: SLA policies, support contracts, ticket types, helpdesk rules, saved views, and CRM-side settings like custom fields and import.

Updated 24 Jun 2026 · 6 views

`/admin/users` is the login-account directory. Distinct from [People](07-customers-people.md) (HR records) and [CRM contacts](04-crm.md) (external).

Updated 24 Jun 2026 · 5 views

Admin · Platform health

The platform-health pages give admins visibility into the running services and recent incidents.

Updated 24 Jun 2026 · 6 views

The admin section (`/admin`) is the configuration hub. Only users with an administrator role (`ADMIN` or `SUPER_ADMIN`) can reach it — open Admin from the **9-dot launcher**, under *Communications & system*.

Updated 24 Jun 2026 · 6 views

Admin · Assets config

Admin pages for the asset register: categories (with auto-numbered tag schemes) and locations.

Updated 24 Jun 2026 · 6 views

Admin · Projects config

Admin pages for projects: **project types** (with auto-numbered project codes) and **task templates**. Both are reachable from the Projects sidebar group, or directly at `/admin/projects/types` and `/admin/projects/templates`.

Updated 24 Jun 2026 · 6 views

Admin · Integrations

The platform integrates with several external services. Each integration has its own admin page where you configure the URL/credentials and toggle the integration on or off.

Updated 24 Jun 2026 · 5 views

Notifications & SMTP

How alarms reach you outside the web UI: MQTT push (in-browser / PWA), email (SMTP), and Home Assistant.

Updated 24 Jun 2026 · 6 views

The platform is licensed by **feature**. Each tenant's enabled [features](19-admin-tenants.md) must be a subset of the licence in effect.

Updated 24 Jun 2026 · 6 views

The platform is **multi-tenant**: a single deployment hosts many **organisations** (tenants), each with isolated data, branding, and users. This is how MSPs run the platform once and serve many customers on it.

Updated 24 Jun 2026 · 5 views

Events & alarms

The event feed, snapshots and clips, acknowledgement, and how alarms turn into notifications.

Updated 24 Jun 2026 · 6 views

System Settings & Capability Coverage

This page maps the current product against the intended NVR/VMS feature set.

Updated 24 Jun 2026 · 5 views

Users, Groups & Permissions

Vistralio uses RBAC plus tenant assignment plus group-based device visibility.

Updated 24 Jun 2026 · 6 views

Vistralio supports object detection, motion detection, ALPR, and face matching.

Updated 24 Jun 2026 · 6 views

Home Assistant integration

Vistralio publishes Home Assistant **MQTT discovery** topics automatically. Once your HA instance is connected to Vistralio's MQTT broker, every camera appears as a `binary_sensor` entity that flips ON when an event fires and OFF when the e

Updated 24 Jun 2026 · 6 views

Admin · RMM config

Admin pages for the RMM module — building **agent installers**, maintaining **metric thresholds**, and configuring **synthetic monitors** and **license monitors**.

Updated 24 Jun 2026 · 5 views

Vistralio can be re-skinned with your own product name, tagline, primary colour, logo, and favicon. The branding is exposed publicly so the **login screen** already shows it before the user signs in.

Updated 24 Jun 2026 · 6 views

DNS and hostname management

Vistralio exposes two independent public hostnames:

Updated 24 Jun 2026 · 6 views

Quick-support & remote sessions

Two related, lightweight ways to reach a customer's machine without deploying a full RMM agent.

Updated 24 Jun 2026 · 6 views

Edge bridges let Vistralio reach devices on remote LANs without inbound port-forwarding.

Updated 24 Jun 2026 · 6 views

Schedules are alarm-suppression rules. They never stop detection from running — they only stop the notifier from paging you for matched events during a defined window. The suppressed events are still recorded.

Updated 24 Jun 2026 · 6 views

Portal overview

This is a guided tour of every section of the portal. Each section ends with a link to its full operator guide.

Updated 24 Jun 2026 · 13 views

Vistralio now includes two licensing surfaces:

Updated 24 Jun 2026 · 6 views

Adding, configuring, and operating devices in Vistralio.

Updated 24 Jun 2026 · 6 views

The dashboard is the operator landing page after login.

Updated 24 Jun 2026 · 5 views

Getting started

Welcome to Vistralio. This page covers your first ten minutes with the system.

Updated 24 Jun 2026 · 10 views

Common billing questions.

Updated 24 Jun 2026 · 9 views

Vistralio can now host multiple tenant workspaces inside one installation while keeping tenant data isolated server-side.

Updated 24 Jun 2026 · 9 views

RMM (Remote Monitoring & Management)

The RMM module manages endpoints — Windows servers, workstations, Linux servers, macOS laptops — through a persistent agent installed on each machine. It can:

Updated 24 Jun 2026 · 10 views

Welcome to KW Group Platform

Everything you need to get started.

Updated 24 Jun 2026 · 43 views

The CRM holds **contacts** and **deals**. It's where you track the people you do business with and your sales pipeline. Contacts can be linked to a **customer** (company) — see [Customers](07-customers-people.md) for the company-side record

Updated 24 Jun 2026 · 45 views

Troubleshooting

Updated 24 Jun 2026 · 6 views

E-Sign sends documents out for digital signature. You build a document from a reusable HTML template, assign signers, and send. Recipients get a unique tokenised link, fill in their fields (including a drawn signature), and the platform rec

Updated 24 Jun 2026 · 6 views

Meetings & calls

Two real-time communication tools live in the portal:

Updated 24 Jun 2026 · 6 views

The knowledge base (KB) hosts articles that staff and customers can search and read. Each article has a **status**: Draft, Published, or Archived. Only **Published** articles appear on the public help centre.

Updated 24 Jun 2026 · 5 views

Messaging & chat

Two distinct in-portal communication tools — and they're not what their names might suggest:

Updated 24 Jun 2026 · 6 views

The rules engine automates ticket workflows. A rule has three parts:

Updated 24 Jun 2026 · 6 views

The Assets module is the register for *physical things* you track — laptops, monitors, switches, printers, network gear, anything physical — beyond what RMM covers. It's separate from RMM because most assets aren't reachable over the networ

Updated 24 Jun 2026 · 6 views

Terms used across the KW Group Unified Platform.

Updated 24 Jun 2026 · 10 views

Getting started

This page walks you through your first sign-in to the KW Group platform and the global navigation that's available everywhere.

Updated 24 Jun 2026 · 13 views

How to submit a support ticket

Get help from our support team.

Updated 24 Jun 2026 · 9 views

Installation & upgrades

This chapter is the operator's reference for spinning up a fresh KW Group platform install or upgrading an existing one.

Updated 24 Jun 2026 · 5 views

The platform has **two separate billing surfaces**:

Updated 24 Jun 2026 · 6 views

The Design studio is the platform's built-in **design editor**. You create design documents — diagrams, posters, social tiles, docs, and whiteboards — on a canvas, version them, and share them with colleagues or via a public link.

Updated 24 Jun 2026 · 6 views

Employees & org chart

The Employees module is the platform's record of who works for the organisation: contract details, compensation, who reports to whom. Each user gets their own self-service view of just their record; admins manage the full tree.

Updated 24 Jun 2026 · 6 views

Two storage tools serve different purposes:

Updated 24 Jun 2026 · 6 views

Customers & people

This chapter covers two related but distinct sections:

Updated 24 Jun 2026 · 4 views

The Projects module is a delivery tracker for work that's bigger than a single ticket — onboardings, migrations, snag lists, internal initiatives. It carries tasks, typed checklists, time tracking, vendor links, and a push to InvoiceNinja f

Updated 24 Jun 2026 · 6 views

Track time across all the work you do in a day — tickets, projects, and ad-hoc activity that doesn't fit either bucket.

Updated 24 Jun 2026 · 5 views

The Marketing module sends bulk email campaigns to contacts pulled from the CRM. Each campaign is a one-off HTML email sent to either all contacts or contacts filtered by status.

Updated 24 Jun 2026 · 5 views

Bringing the user guide into the KB

The platform user guide is authored as Markdown files in `/opt/docs/user-guide/*.md`. Out of the box those files only live on disk — they're not in your KB module, so you can't search or share them from `/admin/kb`.

Updated 24 Jun 2026 · 6 views

The helpdesk is where staff handle support tickets. Every ticket carries a `source`, one of three values:

Updated 24 Jun 2026 · 7 views

Vistralio — DevOps / Internal Runbook

## Service topology

Updated 24 Jun 2026 · 7 views

Vistralio — Architecture

## Process model

Updated 24 Jun 2026 · 11 views

Troubleshooting login issues

Can't log in? Try these steps.

Updated 24 Jun 2026 · 8 views