Erdinc Akay

Endpoint documentation for the octoja REST API

API Reference

octoja uses JWT-based authentication for API clients and an HTTP session cookie for browser-based flows.

API Authentication

Returns the platform version — no authentication required

About API

Retrieves activity log entries recorded for a device — remote actions, terminal sessions, tasks, patch activity, and software deployments

Asset Logs API

REST API reference for managing customers and sites programmatically in octoja.

Customers API

List, retrieve, update, and delete devices via the REST API.

Devices API

Create, read, update, and delete groups via the REST API.

Groups API

Create, manage, and comment on cases programmatically, and log time against them — with a pointer to the interactive API reference for the full spec.

Cases API

Reference list of octoja error codes with explanations and troubleshooting steps.

Error Codes

REST endpoints to list, retrieve, create, update, and delete users in octoja.

Users API

Schema, REST endpoints, widget catalogue, grid constraints, and permission reference for the octoja Reports area.

Reports Reference

Feedback

Roadmap

Changelog

Stefan Steuer

Start here – understand what octoja is and how it can help you

Overview

Learn what octoja RMM is, what it does, and who it is built for.

What is octoja RMM?

What to do when octoja is unreachable or a page does not load

octoja Availability & Status

Definitions of the main objects and terms used in octoja

Core Concepts

What you can find on help.octoja.de and how the octoja Help Center is structured

Help Center

octoja is a remote monitoring and management platform for IT service providers.

Core RMM Capabilities

How to use the octoja community forum at community.octoja.de for questions, discussion, and shared experience

Community Forum

For the best experience, use Google Chrome — the recommended browser for octoja. Other Chromium-based browsers such as Microsoft Edge are fully supported too.

Supported Browsers

See which version of octoja you are running and where to find the changelog — including how to tell which release a completed feature request shipped in.

Find Your octoja Version and Changelog

Learn octoja step by step — start here if you are new

Getting Started

Log into octoja for the first time and find your way around

Step 1 – Your First Login

Add a company to octoja so you can start monitoring their devices

Step 2 – Create Your First Customer

Install the octoja agent on a device so it can be monitored

Step 3 – Deploy Your First Agent

Set up a monitoring check on a device and see it run

Step 4 – Activate Your First Check

Open the home dashboard and filter by severity, status, customer, and device kind.

Step 5 – Get an Overview at a Glance

Step-by-step instructions for specific tasks in octoja

How-To Guides

Transfer customers and other assets from other similar products to octoja

Migration

Translate PowerShell monitoring scripts from another RMM into octoja Custom Checks — paste or upload them, let octoja translate, test each one, then import.

Import monitoring checks with the Check Importer

Bring customers, sites and devices from an existing RMM such as NinjaOne or Datto into octoja — connect both systems, mirror customers, then roll out the agent.

Migrate from a connected source RMM to octoja

Add customers and the sites where their devices live

Customers

Step-by-step guide to adding a new location to a customer in octoja.

Add a Site

Step-by-step guide to creating a new customer in octoja and adding their sites.

Create a Customer

How to read, search, sort, and export the Customers table — your single list of every customer you manage in octoja.

The customers overview

Bulk-create octoja customers by uploading a CSV or Excel file and mapping its columns to customer fields.

Import customers from CSV or Excel

Manage who has access to octoja and what they can do

Users & Groups

Step-by-step guide to creating a new user account in octoja and assigning permissions.

Create a User

Group users or devices together for easier management

Create a Group

Step-by-step guide: assigning permissions for users and groups in octoja.

Assign Permissions

Define rules that automatically apply tags to devices based on their properties — re-evaluated on every inventory update.

Configure Tag Rules

Scope a group to specific customers and devices and limit what its members may do, using the Customer Access and Device Access tabs.

Restrict a Group's Customer and Device Access

Sign-in security — passwords, two-factor authentication, and single sign-on

Authentication

Set up two-factor authentication on your own octoja account, or enable or remove it as an administrator for another user.

Enable Two-Factor Authentication for a User

Connect your Microsoft account and sign in to octoja without a separate password

Sign in with Microsoft (SSO)

Change your own password from your profile, or have an administrator reset it if you are locked out

Reset Your Password

Install and manage the octoja monitoring agent on devices

Agents

Install the octoja Agent on a Windows computer or server

Deploy the Agent on Windows

Step-by-step guide to installing and deploying the octoja agent on Linux.

Deploy Agent on Linux

Step-by-step guide: installing and deploying the octoja Agent on macOS.

Deploy the Agent on macOS

By default, any device that knows your octoja server URL can enroll an agent. For production environments, you can require new devices to present an enr...

Configure Agent Enrollment Tokens

The octoja Agent updates itself automatically — see each device's agent version, trigger an update manually, and fix agents that stay outdated.

Update the Agent

Uninstall the octoja Agent on Windows, macOS, and Linux — and what deleting a device from the octoja inventory does on the machine itself.

Remove the Agent from a Device

Control whether the octoja agent icon shows in the system tray on managed devices — set it for a group via a config package, or override it per device.

Show or Hide the octoja Agent Tray Icon on Managed Devices

Working with devices, terminals, and live monitoring

Devices

The octoja device detail page shows live telemetry for any connected device, updated every two seconds without a page refresh.

Monitor Device Performance Live

View and control a device's screen from the octoja web interface - Toolbox panel walkthrough for Windows agents.

Use Remote Desktop

Open a live terminal session directly from the octoja web interface and run commands on any connected device — no VPN or extra tools required.

Open a Terminal on a Device

Use the Inventory page to search, filter and export software, hardware and services across every device at once.

Search the fleet inventory

Refresh a device's inventory on demand from its detail page — and understand the messages octoja shows when the scan cannot start.

Trigger an inventory scan manually

Restart a managed device from octoja by running the OS restart command in a remote terminal — or restart a single service without a full reboot.

Restart a Device Remotely

Monitor a switch, router, firewall, printer or FRITZ!Box in octoja without installing an agent — one of your existing agents probes it over SNMP or TR-064.

Add a Network Device Without an Agent

Install and update third-party software on managed devices

Software Deployment

This guide walks you through adding a software deployment to a config package so that octoja installs or updates the software on your managed devices au...

Deploy Software to Devices

Upload your own installers (MSI or EXE) as custom packages and deploy them to Windows devices through the standard ConfigPackage flow.

Build and Deploy a Custom Package

Configuration fields, package managers, and schedule syntax for software deployments

Software Deployment Reference

Turn on the Software Kiosk so the people using your managed devices can self-install approved software from the octoja agent in their system tray.

Enable the Software Kiosk

Create and customize monitoring dashboards

Dashboards

An overview of octoja's per-customer dashboard — its four KPI tiles, three device cards (top critical, new, and offline devices), and the alarm history chart.

The customer dashboard

Put your fleet's warnings, critical issues and offline servers on a full-screen board with octoja's TV View — open it, filter it, and set its alert sounds.

Set Up the TV View for Live Fleet Status

Shortcuts, navigation tricks, and features that help you work faster in octoja.

Tips & Productivity

Favorites, recent items, hover cards, view switching, and URL sharing — the most useful features for finding devices, cases, and customers faster.

Navigate octoja Faster

Collect octoja Asset Logs, agent log files, and browser logs from any device and attach them to a support case via the in-app support-tickets portal.

Gather logs for a support case

All keyboard shortcuts available in octoja for faster navigation and actions.

Keyboard Shortcuts

The command bar is a quick-access search and action menu on every page of octoja. Press Ctrl+K (⌘K on Mac) to open it and type to find what you need.

Use the Command Bar

Open Preferences in My Profile to choose the start page that opens after sign-in and to decide whether devices open in a new browser tab.

Set Your Profile Preferences

Connect octoja to third-party tools and services

Integrations

Receive signed JSON events from octoja at your own HTTPS endpoint.

Set up Webhooks

Connect octoja to a Microsoft Teams channel and post alert cards via Power Automate.

Send Alerts to a Microsoft Teams Channel

Connect lywand software to octoja to see a security rank and vulnerability list on every device.

Set up lywand software

Connect octoja to woasi so customer, site, and device inventory flows outbound on an hourly schedule.

Set Up the woasi Integration

Connect Codemeta OS to octoja to raise tickets from check alerts, sync devices, and import customers using a Codemeta OS API key and your Workspace ID.

Set up the Codemeta OS integration

Connect octoja to Hudu so you can import customers from Hudu and sync your devices into Hudu as assets on an hourly schedule.

Set up the Hudu integration

Connect Bitdefender GravityZone to octoja to see agent health, quarantined threats and EDR incidents on every device.

Set up the Bitdefender integration

The ESET Security check runs on the device and reads ESET Endpoint or Server Security locally — no cloud access, no credentials, no customer matching.

Monitor ESET protection with the ESET Security check

The Securepoint Antivirus Pro check runs on the device itself and reports the GuardX service, real-time protection, signature age and threats to octoja.

Monitor Securepoint Antivirus Pro on your devices

Build a custom PDF report from octoja widgets — KPI cards, charts, tables and cases — and generate it for a specific customer, site, or your whole tenant.

Create a report template

Apply your logo and colours to the octoja web interface

Configure Branding

Cases let you track issues, tasks, and service requests in octoja. Assign to a user, link to a device, set priority, and add comments as work progresses.

Manage Cases

Step-by-step guide to attaching alert rules to a monitoring check in octoja, so a channel is notified when the check keeps failing.

Set up alerts for a check

Build a workflow in octoja that reacts to a new device or a schedule and runs actions — scripts, installs, restarts, tickets — across your devices.

Create an automation

Understand the ideas behind how octoja works

Concepts

How octoja organises customers, sites, and devices

Customer, Site, and Device Model

Learn how users, groups, permissions, and customer and device access work together in octoja.

Users, Groups & Permissions

How login and identity verification works in octoja

The Authentication Model

A check is an automated test that an octoja agent runs on a device at regular intervals. Each check monitors a specific condition — disk space, service ...

Checks

How octoja manages language and regional settings in the web interface.

Localization Model

The octoja API provides HTTP endpoints for working with platform data and operations programmatically.

API Design Principles

Overview of the octoja architecture and its main components.