Get a Quote     (408) 943-4100   TrueNAS Discord VendOp_Icon_15x15px Commercial Support
TrueNAS.com Software Systems Company Community Security iX Portal Download
TrueNAS CORE TrueNAS Enterprise TrueNAS SCALE Compare Editions TrueCommand Software Status FreeNAS
Compare Systems F-Series M-Series X-Series R-Series Mini Series
About iXsystems Our Clients Reviews Careers Awards iX Blog & News iX Website Contact Us
Community Forum Discord TrueNAS GitHub TrueNAS Merch Store
Application Analytics Backup and Archival Cloud Data Mobility File Sharing iX Storj Media Creation Video Surveillance Virtualization
Industry Automotive Education Gaming Government Healthcare MSP Manufacturing Research & AI Media & Entertainment
Download TrueNAS CORE Download TrueNAS SCALE Get TrueNAS Enterprise Compare TrueNAS Editions Where to Buy
  1. Documentation Hub
  2. /
  3. TrueNAS SCALE
  4. /
  5. UI Reference Guide
  6. /
  7. Top Toolbar
  8. /
  9. Settings Options
  10. /
  11. API Keys Screen
Edit page
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.

API Keys Screen

  1 minute read.

Last Modified 2024-03-15 13:07 EDT

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.

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

Always back up and secure keys. The key string displays only one time, at creation!

To manage API keys in the TrueNAS SCALE CLI, use the auth api_key namespace.

API Key Documentation

Click API Docs to access API documentation for your system.

Related Content

SCALE Tutorials
SCALE CLI Reference

Have more questions?

For further discussion or assistance, see these resources:

Found content that needs an update?  You can suggest content changes directly! To request changes to this content, click the Feedback button located on the middle-right side of the page (might require disabling ad blocking plugins).