Server Monitor API
The Server Monitor API lets you read monitoring data (components, incidents, status) so you can build status pages, badges, and alerting pipelines. The API is read-oriented and intended for server-side or trusted clients only.
Typical use cases
- Public status page — Poll status and components, show operational state and incident history.
- Status badge — Embed a small "all systems operational" (or current state) badge on your site.
- Alerting and incident pipelines — Consume incidents and maintenance events to trigger notifications or ticketing.
Base URL and version
Base URL: https://faciotech.com/modules/addons/faciotech_monitor/api.php
Version: v1
All documented endpoints are relative to this base URL. API keys are created in the monitoring dashboard; this documentation does not generate or expose keys.
This documentation is informational only. It does not generate API keys or provide a live API explorer. Manage your keys from the monitoring dashboard.
Quick links
- Getting started — Concepts and how to get an API key.
- Authentication — Using your API key and best practices.
- Endpoints — Full reference for status, components, and incidents.
- Webhooks — Event types and payloads (if supported).
- OpenAPI — Machine-readable spec (YAML).
