Skip to main content
Connect a TrueNAS ZFS storage appliance (SCALE 25.04 and later). Myrmex talks to it over JSON-RPC 2.0 on a WebSocket, because the REST API was removed in 25.10.

​
What Myrmex Can Do

Storage

Pools, vdevs and disks with their health; datasets and zvols; snapshots and snapshot tasks.

Sharing and access

SMB, NFS and iSCSI shares; local users and groups; services.

Data movement

Replication and cloud sync, apps, alerts and system posture.

​
Before You Start

  • A TrueNAS API key, and an appliance on SCALE 25.04 or later.
  • A Collector that can reach it.
Scope the credential to what Myrmex should reach. A narrower one still connects — it just leaves the agents with less reach.

​
Create the Credential

1

Open the API keys screen

From the user settings menu in the top toolbar choose My API Keys, or go to Credentials → Users, select the user and click View API Keys.
2

Add a key

Select Add API Key, give it a descriptive name, and pick the administrative user it acts as — the key inherits that user’s rights.
3

Set the expiry

Non-expiring is on by default. Clear it and pick a date in Expires On to have the key expire on its own.
4

Copy it once

Save, and TrueNAS shows the 64-character key only in that dialog. Copy it into Api token before closing.
See TrueNAS’s Managing API Keys. The Username field defaults to truenas_admin — set it to the user the key belongs to.

​
Add the Integration in Myrmex

From the Directory, choose Add Integration → TrueNAS, then fill in:
The integration is tied to the context you have selected when you create it.
Keep Verify ssl and the TLS path intact. TrueNAS permanently revokes an API key that is presented over a plain ws:// connection — recovering means issuing a new key.

​
Connect

Click Connect to validate and finish. It then appears in the Directory. New to integrations? See the Integrations overview.