On this page0
Unfamiliar word? See Glossary: words used in these docs. Looking for the tasks in order? Begin at Start Here.
Reference
Your Customer Dashboard (Instance Status)
The Overview tab of your customer dashboard (the status strip and the Your instance card) shows the live status of every instance we host for you — whether it's online, how many users are on it, and which features are active — all derived from the signed check-in (heartbeat) your instance sends every 5 minutes.
Reading Your Dashboard
Each instance card shows a coloured status dot, the last time it checked in, its software version, and the user count. If anything looks off, this is the first place to look.
Online / Idle / Offline
Users On Your Instance
Entitlement Matrix
If A License Lapses
The status on this page is about the check-in between your instance and Zonitix. It does not show whether every part of the instance is working. For that, your administrator opens System → System Health in the instance itself; the steps are in Check system health.
What Happens When A Subscription Lapses
Your instance enforces this itself, from a paid-through date that the store signs and sends on the heartbeat. Paid modules pause only when both are true: the signed date is more than 14 days in the past, and the store has answered your instance since that date. Your data and the core features stay available throughout. The full rule, what stays available, who is warned and how it is restored are on License Administration.
If something here is not working as you expect, start with When something goes wrong.
The plain explanation is above. This part is for IT and developers: the exact settings, permission names, API addresses and data fields behind it. Closed: select the heading above to open it. While it is closed, your browser’s find-on-page (Ctrl+F or Cmd+F) does not search this part.
// Your instance reports usage; the Store replies with feature entitlements
{
"licenseType": "Advanced",
"config": { "compliance": true, "finance": true, "kill_switch": false },
"usage": { "userCount": 42 }
}
Liveness & Telemetry
Liveness is derived from lastHeartbeat; every check-in also appends an append-only HeartbeatLog row for uptime/usage history. That history is pruned daily — the last HEARTBEAT_RETENTION_DAYS (30 by default) are kept, older rows are swept — so the table stays bounded without losing recent incident context. The portal reads it all from a single customer-scoped, secret-free endpoint.
// Liveness thresholds (expected check-in: every 5 min)
online → last beat < 10 min ago
idle → 10–15 min ago
offline → > 15 min ago
// Self-service health for the instances licensed to you:
GET /api/user/instances → [{ tier, status, instanceStatus, entitlements, health }]
// No seat limits are returned, because there are none.
Not Yet: Remote Lockdown
You will see a kill_switch key in the entitlement config. It is reserved and currently inert — your instance stores the value and no code reads it back, so nothing we send in that field disables anything on your side.
When Part Of The Instance Is Down
For the services inside the instance, see System Health Screen Reference.
Inside the instance, every request goes through one gateway. On most routes, when a service behind it cannot be reached the caller gets 504 with the error Gateway Timeout; after five failures in a row the gateway answers 503 for that service alone, for 15 seconds at a time, while the other services keep answering. By default the gateway waits up to 300 seconds for a service before giving up. Zonitix publishes no uptime SLA. What each outage looks like to a caller and to an administrator, case by case, is on Failure Modes.