Skip to main content

​
API Keys

API keys are essential for programmatically accessing Heex services. Use this page to create, manage, and rotate your API keys securely.

​
Overview

API Keys API keys provide authentication for:
  • Heex CLI - Authenticate command-line operations
  • Heex Installer - Install and configure Heex on your systems

​
Creating API Keys

In this section you can create new API keys and copy them for use with the Heex CLI or Heex Installer.

​
Steps to Create a Key

  1. Open the menu and navigate to API Keys
  2. Click Create New API Key
  3. The key is automatically copied to your clipboard
API keys expire after one year by default.
💡 Tip: Never share your API key publicly. Treat it like a password and store it securely. If a key is compromised, revoke it immediately and generate a new one.

​
Managing Existing Keys

  • View Keys - See all active keys with creation and expiry dates
  • Copy Keys - Copy keys to clipboard for use
  • Revoke Keys - Delete compromised or unused keys immediately
  • Rotate Keys - Create new keys before old ones expire

​
Security Best Practices

  • Limit scope - Use separate keys for different purposes (dev vs production)
  • Store securely - Use environment variables or secret management tools
  • Rotate regularly - Replace keys periodically, especially after team changes
  • Revoke immediately - Delete keys as soon as they’re compromised or no longer needed

​
Using API Keys

​
With Heex CLI

# Login with API key
./heex login --api-key <API_KEY> --save-as <USERCONFIG_NAME>

# Verify authentication
heex whoami

​
With Heex Installer

# Install Heex Agent with API key
heex-installer --api-key <API_KEY>