TrueNAS SCALETrueNAS SCALE Nightly Development Documentation
This content follows experimental early release software. Use the Product and Version selectors above to view content specific to a stable software release.

Managing API Keys

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.

API Keys Screen
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.

Add API Key
Figure 2: Add API Key

Type a descriptive name and click Add. The system displays a confirmation dialog and adds a new API key to the list.

Editing or Deleting an API Key

Select the icon for any API key on the list to display options to manage that API key. Options are Edit or Delete.

Edit API Key
Figure 3: Edit API Key

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.

Delete API Key
Figure 4: Delete API Key

API Key Documentation

Click API Docs to access API documentation that is built into the system.