Vollständige REST-API-Abdeckung
Monitore, Alerts, Incidents, Statusseiten und Pläne teilen sich eine REST API mit JSON-Anfrage- und Antwort-Bodies.
Eine REST API für die Ressourcen, die Sie im Dashboard verwalten: Monitore erstellen, Alert-Kanäle konfigurieren, Incidents und Statusseiten führen und API-Schlüssel per Code oder über Ihre bestehende CI/CD-Pipeline rotieren.
Die REST API von Site Qwality deckt Monitore, Alert-Regeln, Benachrichtigungskanäle, Rufbereitschafts-Pläne, Incidents und Statusseiten ab, damit Teams die Provisionierung ohne manuelle Dashboard-Arbeit automatisieren können. Die Kontoverwaltung, etwa Nutzer und Rollen, braucht einen angemeldeten Admin.
Monitore, Alerts, Incidents, Statusseiten und Pläne teilen sich eine REST API mit JSON-Anfrage- und Antwort-Bodies.
Geben Sie einem Schlüssel Lese- oder Schreib-Scopes für bestimmte Ressourcenfamilien wie Monitore, Incidents oder Benachrichtigungen, damit CI-Pipelines minimale Zugriffsrechte erhalten. Ein Schlüssel ohne Scopes hat vollen Zugriff.
Logs, Traces und Metriken per OTLP/HTTP an https://otlp.siteqwality.com senden. JSON-Logs und -Metriken, Prometheus Remote Write, Fluent Bit, Vector sowie die Adapter für Heroku, Cloudflare und Amazon Data Firehose funktionieren ebenfalls. gRPC, Syslog über TLS und Vercel-Log-Drains sind noch nicht verfügbar, und es gibt keinen öffentlichen UDP-Port für StatsD.
Jede Anfrage, die etwas ändert, wird mit API-Schlüssel oder Nutzer, Quell-IP und Aktion aufgezeichnet, und Sie können sie im Dashboard einsehen.
Jede Zustellung an eine Webhook-Integration trägt einen HMAC-SHA256-Signatur-Header, damit Ihr Empfänger die Payload vor der Verarbeitung prüfen kann. Siehe Webhooks für die genaue signierte Zeichenkette.
Wir generieren ein OpenAPI-3.1-Dokument direkt aus den Routendefinitionen, sodass es nicht von der beschriebenen API abweichen kann. Sie finden sie unter docs.siteqwality.com/api-reference.
Fügen Sie einen curl-Befehl in Ihren CI-Schritt ein, und Monitore, Kanäle, Pläne und Statusseiten werden genauso erstellt, wie Sie Ihre übrige Infrastruktur deployen. Nutzen Sie GitHub Actions oder ein Shell-Skript, was auch immer Ihre Deploys heute steuert.
Erstellen Sie separate API-Schlüssel für Ihre CI-Pipeline (write:monitors), Ihr Dashboard-Tool (read:monitors und read:metrics) und Ihre Rufbereitschafts-Skripte (write:incidents). Widerrufen Sie jeden Schlüssel unabhängig, ohne andere zu beeinträchtigen.
REST-API-Endpunkte für jede Ressource
Traces aus jedem OpenTelemetry-SDK, neben der REST API
API-Zugang in jedem Tarif, auch im kostenlosen
OpenAPI-Version der veröffentlichten API-Referenz
Die vollständige API-Referenz finden Sie unter docs.siteqwality.com. Sie enthält Anfrage- und Antwortschemata und Authentifizierungsdetails für jeden Endpunkt.
Übergeben Sie Ihren API-Schlüssel als Bearer-Token im Authorization-Header: Authorization: Bearer $SQ_TOKEN. Schlüssel erstellen und verwalten Sie unter Einstellungen → API-Schlüssel im Dashboard.
Logs, Traces und Metriken per OTLP/HTTP an https://otlp.siteqwality.com senden. JSON-Logs und -Metriken, Prometheus Remote Write, Fluent Bit, Vector sowie die Adapter für Heroku, Cloudflare und Amazon Data Firehose funktionieren ebenfalls. gRPC, Syslog über TLS und Vercel-Log-Drains sind noch nicht verfügbar, und es gibt keinen öffentlichen UDP-Port für StatsD.
Ja. Der API-Zugang ist in jedem Tarif enthalten, auch im kostenlosen Tarif. Scoped API-Schlüssel funktionieren in allen Tarifen.
Uptime, Cron, Synthetic, Logs, RUM, Incidents und Statusseiten. Kostenlose Stufe bei jedem Produkt.