TrueNAS SCALE 25.10 (Goldeye) – Is REST deprecated for ZFS? Is WebSocket JSON-RPC now the only supported API?

Apps and Virtualization
,
1

I am developing an internal Flask application that queries ZFS snapshots from TrueNAS SCALE 25.10.1 (Goldeye).

I verified that:

• The REST OpenAPI spec (/api/v2.0) does not include any /zfs/snapshot endpoints.

• Calling /api/v2.0/zfs/snapshot/query returns 404.

• However, the WebSocket JSON-RPC endpoint (wss://host:444/api/current) works correctly when using:

auth.login_with_api_key
zfs.snapshot.query

This suggests that ZFS-related APIs are no longer exposed over REST in 25.10.

My questions:
1. Is REST officially deprecated for ZFS operations in Goldeye?
2. Is WebSocket JSON-RPC now the only supported method for querying ZFS snapshots?
3. Is there an officially recommended pattern for external applications interacting with middleware in 25.10?

I want to ensure I am building against the intended long-term API surface.

Thank you.

2

Then you should be using the Websocket API. The REST API is deprecated in 25.04, though it’s still present; I believe it’s supposed to go away completely in 26.

1 Like