SCALE API

1 minute read.

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:

SCALE Documentation Sections

TrueNAS SCALE documentation is divided into several sections or books:

The Getting Started Guide provides the first steps for your experience with TrueNAS SCALE:
- Software Licensing information.
- Recommendations and considerations when selecting hardware.
- Installation tutorials.
- First-time software configuration instructions.
Configuration Tutorials have many community and iXsystems -provided procedural how-tos for specific software use-cases.
The UI Reference Guide describes each section of the SCALE web interface, including descriptions for each configuration option.
API Reference describes how to access the API documentation on a live system and includes a static copy of the API documentation.
SCALE Security Reports links to the TrueNAS Security Hub and also contains any additional security-related notices.