Skip to main content
Network

STARFACE PBX

Monitor the licence, TLS certificate, NTP, and SIP reachability of your STARFACE PBX through its REST API and SIP ports.

The STARFACE PBX check monitors a STARFACE through its REST API and SIP ports. It checks the licence, TLS certificate, NTP, and SIP reachability and shows the current call load. The check runs every 5 minutes by default.

Prerequisites

  • A device with the octoja agent that can reach the STARFACE web port and configured SIP ports.
  • The Login ID of a STARFACE administrator account (not its email address) and its password.
  • For STARFACE 10 and later: the API access with OAuth Password Grant permission and the client secret from Admin > Server > Configuration > REST API. Use classic login for STARFACE 6.7–9.

Steps

  1. Add STARFACE PBX to the reachable device.
  2. Enter only a hostname or IP address under Host, without a scheme or port. Port defaults to 443 and Use HTTPS is on.
  3. Select OAuth (STARFACE 10+) or Classic login (STARFACE 6.7–9) under Authentication, then enter the credentials. OAuth client ID defaults to rest-client-headless.
  4. Review the areas to monitor and save.

For assignment and required permissions, see Assign checks with config packages.

Settings

FieldTypeRequiredDefaultDescription
HostStringYes—Hostname or IP address of the STARFACE, without scheme or port
PortIntegerNo443Web port of the STARFACE
Use HTTPSBooleanNoOnConnect over HTTPS
Allow self-signed certificatesBooleanNoOnOnly with Use HTTPS enabled. Connects despite an untrusted certificate; expiry is still evaluated
AuthenticationSelectYesOAuth (STARFACE 10+)OAuth (STARFACE 10+) or Classic login (STARFACE 6.7–9)
Login IDStringYes—STARFACE login ID of an administrator account (not the email address)
PasswordPasswordYes—Password of the account
OAuth client IDStringNorest-client-headlessOAuth only
OAuth client secretPasswordNoEmptyOAuth only. Secret of the headless client from Admin > Server > Configuration > REST API. Without a secret, the check reports a failure
License expiryBooleanNoOnEvaluates the earliest expiring server licence
License warning (days) / License critical (days)IntegerNo30 / 7Shown only while License expiry is on
TLS certificate expiryBooleanNoOnOnly with Use HTTPS enabled. Evaluates the certificate presented by the web server
Certificate warning (days) / Certificate critical (days)IntegerNo30 / 7Shown only while TLS certificate expiry is on
NTP time synchronisationBooleanNoOnWarns when the PBX does not use NTP
SIP reachabilityBooleanNoOnConnects to the SIP ports from the agent. A closed TCP/TLS port is critical
SIP port (TCP/UDP) / SIP TLS port (0 = skip)IntegerNo5060 / 5061Shown only while SIP reachability is on. 0 skips that port
SIP OPTIONS pingBooleanNoOnSends a SIP OPTIONS request over UDP to the SIP port. No reply is only a warning

Disable SIP reachability for hosted systems that intentionally block SIP from the checking device.

Results

A successful result means authentication and every enabled test completed; warning or critical results identify the affected area.

  • Licence and certificate thresholds already trigger when the remaining days reach the value; an expired licence or certificate is critical. If you enter the warning and critical values the wrong way round, the check swaps them before evaluating.
  • Call load and licence usage are shown for information only and do not affect the result.
  • If a queried REST endpoint answers 403 or 404, for example because of missing permissions, the check reports a warning for it.