Configure the MailStore SPE User Count Check

Set up the MailStore SPE check to count archived users per instance via the SPE Management API.

Written By Stefan Steuer

Last updated 28 days ago

Configure a MailStore SPE User Count Check

The MailStore SPE User Count check reports how many users are archived in each MailStore Service Provider Edition (SPE) instance on a Windows server, and totals them across the whole SPE deployment. octoja talks to the SPE Management API directly — no per-instance access is needed. Stopped instances still count toward the total when license data is available.

Requirements

  • MailStore SPE installed on a Windows server
  • The octoja agent installed on the same server (or any Windows host that can reach the SPE Management API)
  • A Management API user with permission to list instances and (optionally) query users — create it under Management Console → User Administration in SPE
  • Network reachability from the agent to the SPE Management API host on TCP/8474 (or your configured port)

Where is the Management Console? On the SPE management host, look for "MailStore SPE Management Console" in the Start menu. Documentation: help.mailstore.com/spe/Management_API.

Steps

  1. Make sure the octoja agent is installed on a Windows device that can reach the SPE Management API.
  2. Go to Devices and open that device.
  3. Click the Checks tab → Add Check → MailStore SPE User Count.
  4. Fill in the connection details:
FieldWhat to enter
ServerHostname or IP of the SPE Management server. Default localhost works when the octoja agent runs on the SPE management host itself
PortManagement API port. Default 8474 matches a stock SPE install
UsernameManagement API user (required)
PasswordPassword for the Management API user (required)
Ignore SSL certificate errorsLeave on for typical SPE installs (self-signed certificates). Turn off only if you have replaced the SPE certificate with one signed by a trusted CA
  1. Click Add Check.

What triggers an alert?

ConditionSeverity
Username or password missingFailure
GetInstances call fails (API unreachable, bad credentials, certificate error)Failure
SPE deployment has zero instancesWarning
At least one instance has an undetermined user count (running + GetUsers failed + no license data)Warning
All instances returned a user countOK

Tips

  • The check runs every 6 hours by default — user counts change slowly in archive workloads, and frequent polling adds load to the SPE management host with no benefit.
  • Use a dedicated read-only Management API user for octoja. If the credentials ever leak, you can rotate them in the SPE Management Console without touching real archive users.
  • If you split SPE across multiple management hosts, configure one check per management host — each is queried independently.
  • The Total users figure in the check result is the sum across all instances, useful for license tracking and capacity planning.

After the first check interval, the result appears in the device's Checks tab with the total and a per-instance breakdown (name, status, user count, count source).

See also: MailStore SPE User Count Check Reference