Getting started

Concepts

• Components / services — Monitored items (e.g. "Web server", "API", "Database"). Each has a current status.
• Checks — Individual checks that contribute to a component's status (e.g. HTTP check, ping).
• Incidents — Reported issues with a title, status, and optional updates over time.
• Maintenance windows — Planned maintenance with start/end; components may show "Maintenance" during the window.
• States — Overall or per-component state: Operational, Degraded, Partial Outage, Major Outage, Maintenance.

How to get an API key

API keys are managed in the monitoring dashboard. This documentation does not create or display keys.

1. Log in to the monitoring dashboard (admin or client area, depending on your access).
2. Go to API Keys (or the equivalent section in the addon).
3. Click Generate key (or "Create API key").
4. Copy the key immediately — it is shown only once. Store it securely (e.g. environment variable or secrets manager).
5. Use the key in API requests as described in Authentication.