Online Help

Audit Services Reference

Reference for the per-Site Audit Service catalog: list view columns, the detail modal, the lifecycle state enum, and the timing of automatic transitions.

List view

Menu path: Admin Center > Site Settings > Tasks and services > Audit services.

Column Type Description
Name String Hostname of the machine that runs the service. Sorted ascending by default.
Id UUID Stable identifier of the service registration.
IP address String Address from which the service last sent a heartbeat.
Registration date DateTime When the service was first installed.
Last active DateTime Most recent heartbeat.
Updater last active date DateTime Most recent heartbeat from the auto-updater that ships with the service.
Version String Service binary version.
Updater version String Auto-updater version.
Expiration date DateTime Scheduled deletion timestamp; populated only when the service is in ScheduledForDeletion.

Detail modal

Open a row to see a modal with three tabs.

General

Field Description
Client ID UUID of the registration. Same as Id in the list.
Host name Hostname of the running service.
IP address Last known address.
Registration date When the service was registered.
Last active Date and time of the most recent heartbeat.
Schedule for deletion Button. Triggers a manual transition to ScheduledForDeletion.

Credentials

Shows the per-service credential pool. See Credentials Reference for the full schema and per-type field tables.

Tasks

Shows the live and recent task queue assigned to this service — Scan #NNN rows for segment scans, Audit #NNN rows for cloud and standard audits.

Lifecycle state enum

State Meaning How it is reached
Active Service is running and sending heartbeats. After install + first heartbeat.
Outdated Service version lags the instance version. Soft state — the service keeps running. Set automatically based on a version comparison; orthogonal to Active / Inactive.
Inactive No heartbeat for longer than the inactivity window. Automatic, after the inactivity window.
ScheduledForDeletion Marked for deletion. Either automatic (after Inactive) or manual (admin clicks Schedule for deletion).

Timing

Setting Default Description
Inactivity window (RetiredPeriod) 30 days Time without a heartbeat before the service is marked Inactive. The same window then applies before deletion completes. End-to-end retirement takes roughly twice this window for an inactivity-driven path.

Note: The inactivity window is a per-Site setting. How to change it through the Admin Center may vary by deployment.

Background process

The RetiredAgentsAndServices background job runs periodically and applies inactivity-based transitions:

  • Active → Inactive when the heartbeat is older than the inactivity window.
  • Inactive → ScheduledForDeletion after a further inactivity window.
  • ScheduledForDeletion → Deleted at the Expiration date.

A service that comes online while in ScheduledForDeletion self-uninstalls instead of being deleted on the server side; the result is the same — the registration goes away.

RBAC

Action Site Administrator Site User
List Audit Services yes yes (read-only)
Open detail modal yes yes (read-only)
Install new Audit Service yes no
Schedule for deletion yes no
Manage credentials yes no