TrueNAS Nightly Development Documentation
This content follows experimental nightly development software. Pre-release software is intended for testing purposes only.
Use the Product and Version selectors above to view content specific to a stable software release.

API Reference

1 minute read.

Last Modified 2024-11-15 16:32 EST

The TrueNAS REST API is deprecated in TrueNAS 25.04 and replaced by the TrueNAS API Client. Full removal of the REST API is planned for a future release.
This new API Client is not the deprecated TrueNAS CLI (midcli). The API Client is integrated in TrueNAS 25.04 onwards. It provides the midclt command-line tool, and the means to easily communicate with middleware using Python to make calls through the websocket API.
This API client allows for better integration of TrueNAS into third-party solutions. Use this as a reference for projects that require direct TrueNAS integration.
TrueNAS API documentation remains available in the UI and through the TrueNAS Documentation Hub.

You can access TrueNAS API documentation in the web interface by clicking > API Keys > API Docs.

SCALEapidocs

Alternatively, append /api/docs/ to your TrueNAS host name or IP address in a browser to access the API documentation.

For convenience, we store static builds of the current 2.0 API documentation on the Docs Hub:

Websocket Protocol