> ## Documentation Index
> Fetch the complete documentation index at: https://docs.myrmex.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# TrueNAS

> 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.

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

<CardGroup cols={2}>
  <Card title="Storage" icon="list-check">
    Pools, vdevs and disks with their health; datasets and zvols; snapshots and snapshot tasks.
  </Card>

  <Card title="Sharing and access" icon="gauge">
    SMB, NFS and iSCSI shares; local users and groups; services.
  </Card>

  <Card title="Data movement" icon="sliders">
    Replication and cloud sync, apps, alerts and system posture.
  </Card>
</CardGroup>

## Before You Start

* A TrueNAS **API key**, and an appliance on **SCALE 25.04 or later**.
* A **Collector** that can reach it.

<Tip>
  Scope the credential to what Myrmex should reach. A narrower one still connects — it just leaves the agents with less reach.
</Tip>

## Add the Integration in Myrmex

From the **Directory**, choose **Add Integration → TrueNAS**, then fill in:

| Field | Description |
| - | - |
| **Name** | A unique name for this instance. |
| **Description** | Optional note to identify it. |
| **Api token** | The TrueNAS API key, stored encrypted. |
| **Url** | The appliance address the Collector can reach. |
| **Port** | `443` by default. |
| **Username** | `truenas_admin` by default. |
| **Api version** | The appliance's API version. |
| **Authentication Type** | `api-key` by default. |
| **Verify ssl** | Validate the certificate (off by default). |
| **Collector** | The [Collector](/documentation/agent-endpoint-security/collector-mode) that reaches it. |

<Note>
  The integration is tied to the **context** you have selected when you create it.
</Note>

## Connect

Click **Connect** to validate and finish. It then appears in the **Directory**. New to integrations? See the [Integrations overview](/documentation/integrations/overview).