MailStore SPE User Count Check Reference

Configuration fields, alert thresholds, and platform support for the MailStore SPE User Count check in octoja.

Written By Stefan Steuer

Last updated 28 days ago

MailStore SPE User Count Check Reference

Configuration options and alert behaviour for the MailStore SPE User Count check.

The MailStore SPE User Count check queries the MailStore Service Provider Edition (SPE) Management API and reports the number of archived users per instance plus a deployment-wide total. It runs every 6 hours on the octoja agent installed on a Windows host that can reach the SPE Management API.

Configuration fields

FieldTypeRequiredDefaultDescription
ServerstringNolocalhostHostname or IP of the SPE Management server
PortnumberNo8474SPE Management API port
UsernamestringYes—SPE Management API user
PasswordpasswordYes—Password for the Management API user
Ignore SSL certificate errorsbooleanNotrueWhen on, self-signed certificates are accepted (typical for SPE). Turn off only with a CA-signed certificate installed on the SPE host

Alert behaviour

ConditionSeverity
Username or password missing in the check configurationFailure
GetInstances API call fails (network error, authentication error, certificate error)Failure
Zero instances returned by SPEWarning
At least one instance has an undetermined user countWarning
All instances returned a user count (running via GetUsers, stopped via license fallback)OK

Metrics collected

Per check run:

  • totalUsers — sum of userCount across all instances
  • instanceCount — number of instances returned by GetInstances

Per instance:

  • instanceId — SPE instance identifier
  • name — instance display name (falls back to alias, then to ID)
  • status — instance lifecycle status from SPE (e.g. Running, Stopped)
  • userCount — archived user count, or null if undetermined
  • source — how the count was obtained: GetUsers (running + API call), License (running + license fallback), License(stopped) (stopped + license fallback), empty (undetermined)

Platform support

PlatformSupported
Windows ServerYes
Windows DesktopYes
LinuxNo
macOSNo

Notes

  • The check runs every 360 minutes (6 hours) on the agent. The interval is not user-configurable.
  • HTTP timeout per API call is 30 seconds.
  • The check uses HTTP Basic authentication. The configured credentials are used only for the API calls and are never included in the check output.
  • A successful run distinguishes three count sources per instance: GetUsers is the authoritative live count for running instances; License is the per-instance usedLicenseCount from the SPE license report, used as a fallback when GetUsers fails; License(stopped) is the same fallback for stopped instances.
  • The check does not capture user names, email addresses, or any archive content — only counts.
  • This check does not monitor the MailStore Server (single-tenant) product. SPE-only.

See also: Configure a MailStore SPE User Count Check