Agents
Agents are external processes that execute jobs (functions) on behalf of users. This page covers Agent Management (agents, agent pools, and pool details) and personal access tokens for agent authentication.
Navigation: Click Agents in the sidebar (or go to /agents)
Page layout
At the top of the Agents page:
- Tabs: All Agents and Agent Pools switch the main view.
- Generate Token: Opens the dialog to create a new agent personal access token (PAT).
Generate an agent token
- Click Generate Token (key icon) in the top-right.
- Enter a Token name and click Generate.
- Copy token stores the value to the clipboard and closes the dialog.
Important: The token is shown only once. If you lose it, generate a new one.
All Agents tab
Filters and search
| Control | Purpose |
|---|---|
| Search by | Module — filter agents by installed module name or version. Name — filter by agent display name. |
| Search | Text field; placeholder depends on Search by. |
| Archive status | Active, Archived, or All. Changing this clears row selection. |
| Pool membership | Any, In a pool, or Not in a pool. |
| Organization | Shown only if you belong to multiple organizations: pick one or All organizations. |
When a search is active, the table loads additional pages automatically so results are not limited to the first page only.
List refresh
When data is loaded, a line shows Updated with the last refresh time.
Status badges
Each agent displays a color-coded status badge:
| Color | Meaning | Examples |
|---|---|---|
| Green | Healthy / idle | Idle, Completed, ExecutionSuccess |
| Yellow | In progress | Running, ExecutingJob, UpdatingModule, Claimed |
| Red | Error or canceled | Any "Failed" status, Unknown, Canceled |
| Neutral | Other | Any status not in the above groups |
The Last updated column shows the timestamp for the current status.
Column sorting
Sortable columns (click header): Agent Name, Status, Last updated, Version, Host OS, Last Restarted. Checkbox, Installed Modules, Pools, and actions are not sortable.
Agents table columns
| Column | Description |
|---|---|
| (checkbox) | Select rows for bulk actions. |
| Agent Name | Display name; agent ID below with copy control. |
| Status | Colored badge (see above). |
| Last updated | Time for current status. |
| Version | Agent software version. |
| Host OS | Operating system. |
| Last Restarted | Last restart time, or Unknown. |
| Installed Modules | Module chips; popover for name/version; overflow as +N more. |
| Pools | Pool name badges for pools this agent belongs to; overflow as +N more. |
| ⋯ | Row actions. |
If more agents exist, use Load more at the bottom of the table.
Agent detail panel
- Click a row (not on links, checkboxes, or menus) to open an agent detail area.
- The detail UI opens in a resizable panel at the bottom of the page (you can drag the splitter or collapse it).
The panel header shows name, status badge, OS, and version, and a close control.
| Tab | Contents |
|---|---|
| Modules & Functions | For each installed module: name, version, install time when known, and a list of catalog functions (display names) supported for that module version. |
| Modules History | Timeline of module install/update/remove events. |
| Status History | Timeline of status changes. |
Bulk actions (selected agents)
When at least one row is selected:
- Create New Pool — Opens Create Agent Pool; after the pool is created, selected agents are added to it (with progress and toasts).
- Add to Pool… — Adds all selected agents to an existing pool.
- Clear selection — Clears checkboxes.
Archive or restore an agent
- Open the ⋯ menu on the row.
- Choose Archive Agent or Restore Agent (restore appears when the agent is archived).
- Confirm if prompted.
Archived agents no longer receive job assignments.
Agent Pools tab
Layout: pools list on the left, pool detail on the right. Click a pool row to select it and load the detail pane.
Pools list controls
- Search pools… — Filters pools by name.
- Status filter: Active, Archived, or All.
- New Pool — Opens Create Agent Pool (name and description).
Sortable columns include Pool Name and Created; Agents and Users counts are not sortable. Use Load more when the list is paginated.
Pool table columns
| Column | Description |
|---|---|
| Pool Name | Click name to select pool without toggling row focus. |
| Agents | Count of agent memberships. |
| Users | Count of user memberships. |
| Created | Creation time. |
| ⋯ | Edit, Archive or Restore (for archived pools). |
Pool detail pane
When a pool is selected, the right side shows the pool name and description and four tabs:
| Tab | Purpose |
|---|---|
| Overview | Summary counts (agents, users, unfinished jobs) and module coverage across agents in the pool (module/version, how many agents provide it, function counts from the catalog). |
| Agents | Agents in the pool; clicking an agent can open the same bottom agent detail panel as on All Agents. |
| Users | Users assigned to the pool. |
| Jobs | Jobs associated with the pool. |
Create or edit a pool
- Create: New Pool (pools view) or Create New Pool (bulk selection on All Agents). Dialog title Create Agent Pool; fields Name (required) and Description; submit creates the pool.
- Edit: ⋯ → Edit on a pool row. Dialog title Edit Agent Pool; update name/description.
Archive or restore a pool
From the pool row ⋯ menu: Archive or Restore for archived pools. Confirm if the app asks for confirmation.