TrueNAS Enterprise
TrueNAS SCALE
TrueNAS CORE
Compare Editions
TrueCommand
Software Status
FreeNAS
Compare Systems
F-Series
M-Series
H-Series
R-Series
Mini Series
Download TrueNAS SCALE
Download TrueNAS CORE
Get TrueNAS Enterprise
Contact an Enterprise SpecialistTrueCommand Version Documentation
This content follows TrueCommand 3.0 releases. Use the Product and Version selectors above to view content specific to TrueNAS software or major versions.
API Interface
2 minute read.
TrueCommand provides an Application Program Interface (API) screen with links to embedded API documentation, system logs, and a request form for sending and receiving API calls.
API documentation built with the TrueCommand version is available from the web interface by opening the admin menu and clicking API.
Alternately, copy the TrueCommand web interface URL to a new browser tab and append /api/swagger.
A static build of this version’s API documentation is also provided here.
Click UI LOG to open a sidebar that shows messages recorded by the TrueCommand user interface. Click to download a local copy of the UI log.
Click MIDDLEWARE LOG to open a sidebar that shows informational and alert messages recorded by the TrueCommand middleware. Click to download a local copy of the middleware log.
Interact with the TrueCommand API using this form. To find the different calls and parameters, refer to the embedded API documentation.
Enter a Name in the form.
This must be path to the desired TrueCommand API call.
The form automatically adds a / character in front of the entered Name.
Example:
alert-plugin/list
Enter any additional parameters in a standardized JSON format. This simple example shows deleting an TrueCommand user account:
