Managing API Keys
2 minute read.Last Modified 2023-11-16 14:55 EST
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 API keys added to your system and allows you to add, edit, or delete keys.
To manage API keys in the TrueNAS SCALE CLI, use the
Click Add to display a dialog window that lets users add a new API key.
Type a descriptive name and click Add. The system displays a confirmation dialog and adds a new API key to the list.
Select the icon for any API key on the list to display options to manage that API key. Options are Edit or Delete.
Select the Reset to remove the existing API key and generate a new random key. The dialog displays the new key and the Copy to Clipboard option to copy the key to the clipboard.
Always back up and secure keys. The key string displays only one time, at creation!
To delete, select Confirm on the delete dialog to activate the Delete button.
Click API Docs to access API documentation that is built into the system.