TrueNAS SCALE Documentation Archive
This content follows the TrueNAS SCALE 22.12 (Bluefin) releases. Archival documentation is provided for reference only and not actively maintained.
Use the Product and Version selectors above to view content specific to different TrueNAS software or major version.

SCALE API

1 minute read.

Last Modified 2023-09-25 08:37 EDT

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

SCALEapidocs

Alternatively, append /api/docs/ to your TrueNAS hostname 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
RESTful