Core Concepts

Definitions of the main objects and terms used in octoja

Object hierarchy

As an IT provider, you manage all of your customers in one octoja instance. The main objects build on each other: customer → site (optional) → device → check. How customers, sites, and devices relate and how octoja keeps each customer's data separate is explained in How customers, sites, and devices work.

Key terms

Term	Definition
Customer	An organisation whose IT environment is managed in octoja
Site	A physical location such as an office, warehouse, or data centre
Device	A monitored workstation, server, network device, or other supported system
Agent	The octoja service installed on a device. It runs the device's checks and keeps it in contact with octoja
Network device	A switch, router, firewall, printer, NAS, ESXi host, or similar system that runs no agent. You add it by hand and pick one of your agent-managed devices as its monitoring asset, which probes it on your behalf
Check	A recurring test, for example disk space, service state, or SSL certificate expiry
Config package	A reusable bundle of checks and device settings. Assign it to one device directly, or let a rule assign it to every device that matches
Alert	The notification sent when a check reports a problem. Under Alert Configurations you decide from which severity an alert fires and where it goes — email, Microsoft Teams, a webhook, app push, a case in octoja, or a ticket in your PSA
Case	A support request or task you work on in octoja, with a status, a priority, and a full history
Maintenance mode	A time window in which octoja pauses checks, alerts, automations, software deployments, or patches for a device so that planned work does not raise alerts
Tag	A label on a device or customer, such as `server` or `pilot`. Tag Rules apply tags automatically to matching devices
Group	Decides what its members may do: permissions for areas of octoja, customer access, and device access
Enrollment token	A token new agents use to register with octoja, for example in a mass deployment. It can preset the customer and site

Typical flow

An IT provider creates a customer record.
They add sites if they need them, and deploy agents on the devices they manage. Network devices are added by hand instead, each paired with an agent-managed device that probes it.
Config packages assign checks to those devices, and the checks run at defined intervals.
Checks report their results back to octoja, where you can see the current state at a glance.

Was this helpful?

Still need help? Ask the team