Skip to main content

Generate an API Key

Create an API key to authenticate the HiAUDIT Agent CLI on your machine.

An API key authenticates the HiAUDIT Agent CLI on your machine. You need at least one active key before installing.

Create a key

StepHow
Open the API Keys pageClick API Keys in the left sidebar.
Click Create KeyGive it a descriptive name (e.g. “My Laptop”) and optionally set an expiry.
Copy the key immediatelyThe full key (starts with hiak_) is shown only once. Copy and save it securely.
HiAudit dashboard API Keys page with the Create Key button in the top-right corner Create API Key modal with fields for key name and optional expiry in days

Save your key

The full API key value is displayed only at creation time. If you lose it, you will need to create a new key.

Treat your API key like a password. Anyone with the key can run the agent under your account.

Next step

With your key copied, continue to install the HiAUDIT Agent.