Tenant Agents
The Tenant Agents page shows your organization's tenant instances and their agent connections. It is visible to users with the Organization Admin role.
Navigate to Administration → Tenant Agents in the portal sidebar.
What is a tenant agent?
A tenant agent is an installation of the kAudit Windows Service Agent on a SQL Server host. Each agent is associated with a tenant (an isolated monitoring environment within your organization) and authenticates to the platform using an agent API key.
Overview panel
At the top of the page you'll see your organization summary:
- Organization name — your registered company name
- License tier — your current plan (e.g., Starter, Professional)
- License expiry — when your subscription renews or expires
Below that, the Tenant Usage panel shows:
- Current / Max instances — how many tenant instances you've used against your license limit
- Online / Warning / Offline agents — a count of agents by health status
Tenant instances
The instances table shows each tenant registered to your organization:
| Column | Description |
|---|---|
| Tenant Name | The display name for this tenant |
| Tenant ID | Unique identifier used in agent configuration |
| Industry | The industry sector assigned to this tenant |
| Status | Active or Inactive |
| Agent Status | Healthy / Warning / Offline (shown as a colored status chip) |
| Last Heartbeat | When the agent last checked in |
Agent health statuses
| Status | Meaning |
|---|---|
| 🟢 Healthy | Agent is sending events and heartbeats normally |
| 🟡 Warning | Heartbeat received but event volume is lower than expected |
| 🔴 Offline | No heartbeat in the expected window — agent may be down |
Managing API keys
Each tenant has one or more API keys used by the agent to authenticate. To manage keys:
- Click the actions menu (⋮) next to a tenant in the table.
- Select Manage API Keys.
- The API Key Management dialog opens showing all keys for that tenant.
Creating a new agent API key
- In the API Key Management dialog, click Create Key.
- Enter a label (e.g.,
Production SQL 01). - Optionally set an expiry date.
- Click Create.
- Copy the key immediately — it is shown only once.
Use this key in the agent configuration file.
Rotating a key
Always create the new key first, update the agent, then delete the old key:
- Create a new key (steps above).
- Update the agent config with the new key and restart the service.
- Confirm the agent is healthy (check the Agent Status column).
- Revoke the old key from the API Key Management dialog.
WARNING
Revoking a key immediately stops it from working. The agent will stop sending events until it is reconfigured with a valid key.
Heartbeat history
Click Heartbeat History next to an agent to see a timeline of recent check-ins. Use this to diagnose connectivity issues or confirm an agent came back online after maintenance.