API_Key Namespace API_Key Commands Interactive Argument Editor (TUI) Create Command Delete Command Get_Instance Command Query Command Update Command The SCALE CLI guide is a work in progress! New namespace and command documentation is continually added and maintained, so check back here often to see what is new! API_Key Namespace The api_key namespace has five commands and is based on API key management functions found in the SCALE API and web UI.
The API Keys option on the top toolbar Settings dropdown menu displays the API Keys screen. This screen displays a list of TrueNAS SCALE API keys on your system and allows you to add, edit, or delete keys.
Figure 1: API Keys Screen Click the icon to the right of an API key to display options for that key. API key options are Edit and Delete.
Use Add to add a new API key to your TrueNAS.
The API Keys option on the top right toolbar Settings (user icon) dropdown menu displays the API Keys screen. This screen displays a list of TrueNAS SCALE API keys on your system and allows you to add, edit, or delete keys. API keys identify outside resources and applications without a principal.
Figure 1: API Keys Screen To manage API keys in the TrueNAS SCALE CLI, use the auth api_key namespace. Adding an API Key Click Add to display a dialog window that lets users add a new API key.