Connect Unraid
Add Unraid to Kochab with an API key for infrastructure health, Docker containers, and storage.
Unraid is an infrastructure service in Kochab (not a blended library surface). Kochab uses Unraid’s GraphQL API, not Portainer and not the raw Docker Engine API.
What Kochab exposes through Unraid
- Infrastructure: array and cache disks, parity status, capacity, CPU/RAM, network, and temperature sensors
- Docker (Unraid-native): container list with Unraid icons, start/stop/restart, pause/unpause, log tail, autostart toggle, and Update (pull + recreate) when Unraid reports a newer image
- Home glance: infra summary card and alerts (degraded array, parity check, critical temps, container down)
Not exposed through Unraid
- VM management, TrueNAS-style catalog apps, or multi-host Docker environments
- Sonarr/Radarr/Plex library data (add those apps separately on their own ports)
- Raw Docker Engine inspect/stats JSON (Unraid surfaces its own Docker UI, not the raw Engine)
If you also add Portainer against the same Unraid Docker socket, you will see duplicate container lists with fewer NAS features. Prefer this native entry on Unraid.
See Infrastructure vs container integrations.
Before you start
In Unraid: Settings -> Management Access -> API Keys. Create a key with access to the GraphQL API. The simplest choice is a key with the Admin role. To give Kochab less, see API key permissions.
Kochab needs Unraid API 4.35 or later. That is Unraid 7.2.8 or later (7.3.2 or later on 7.3), or any Unraid 7.2 or later with an up-to-date Unraid Connect plugin, which updates the API ahead of the OS.
On an older API, the Unraid screen in Kochab shows a notice and what it can load. From API 4.30 that is everything except network activity. API 4.29 also lacks temperatures and the UPS. Below API 4.29 the container list and alerts cannot load.
API key permissions
A key with the Admin role works for everything on this page and needs no further setup.
If you would rather create a scoped key, give it every permission in this table. Kochab asks Unraid for each of these when it loads the matching part of the screen, and a missing one leaves that part empty or its action refused.
| Permission | What Kochab uses it for |
|---|---|
INFO:READ_ANY |
Server name and version, CPU, memory, temperatures, and network activity |
ARRAY:READ_ANY |
Array state, capacity, pools, and parity check history |
VARS:READ_ANY |
Missing array disks and filesystem state (optional; without it, missing disks are unknown) |
ARRAY:UPDATE_ANY |
Pausing, resuming, and canceling a parity check |
DISK:READ_ANY |
Disk list and disk health |
DOCKER:READ_ANY |
Container list, update status, and container logs |
DOCKER:UPDATE_ANY |
Start, stop, restart, pause, update, and autostart for a container |
CONFIG:READ_ANY |
UPS status |
NOTIFICATIONS:READ_ANY |
The Alerts section |
NOTIFICATIONS:UPDATE_ANY |
Dismissing an alert |
REGISTRATION:READ_ANY |
License state |
VMS:READ_ANY |
The VM list and the Manage VMs link |
VMS:UPDATE_ANY |
Start, stop, pause, resume, and force stop for a VM |
For a read-only setup, leave out the four UPDATE_ANY permissions. Kochab still shows everything, and parity check controls, container actions, VM actions, and dismissing alerts are refused by Unraid.
Unraid’s Viewer role grants every READ_ANY permission above, so Viewer plus the four UPDATE_ANY permissions is the same as the full table.
Default connection
| Field | Typical value |
|---|---|
| Port | 443 (HTTPS web UI) |
| Scheme | https |
| Auth | API key in the X-Api-Key header |
Add in Kochab
- Open More > Stacks & Services > + > Add service and choose Unraid.
- Enter your tower hostname or IP (for example
tower.local). - Port 443 unless you use a custom TLS port.
- Paste the API key.
- Tap Test & Add.
- Open Infrastructure from the service row or Home card for pools, stats, and containers.
TLS
Unraid commonly uses a self-signed certificate. Trust the fingerprint when Kochab prompts you. See Certificate trust.
Tips
- Container Update (pull latest image) is available on Unraid’s native surface when an update is available.
- Roaming: add an external URL on the stack if you reach Unraid over VPN or a public hostname away from home.