API-Referenz

Alarme-API

Alarme: offene Bildschirmprobleme, Quittierung, Zurückstellung und Stummschaltungen

HTTP-Referenz. Generiert aus dem Backend-Vertrag. Durchsuchen Sie die Endpunkte unten oder laden Sie OpenAPI herunter.

Diese Gruppe hat 6 Operationen, generiert aus api/openapi.yaml. Filtern Sie nach Pfad, Aktion oder Authentifizierung. Jeder Endpunkt listet seine Eingaben auf; klappen Sie ihn auf, um eine Anfragevorlage und die Antwortcodes zu sehen. Die Vorlagen brauchen Ihre eigenen Werte und einen schemagültigen Anfragekörper.

Großgeschriebene Platzhalter durch Ihre Werte ersetzen. Für eine JSON-Anfrage speichern Sie einen Body, der dem Schema in request.json entspricht. Cookie-Beispiele verwenden ein lokales Cookie-Archiv aus einer authentifizierten Sitzung.

Alarme: offene Bildschirmprobleme, Quittierung, Zurückstellung und Stummschaltungen

GET/api/alerts

Alarme auflisten

Listet die Bildschirmalarme des Projekts auf: einen pro Bildschirm und Bedingung, solange sie andauert (open), und die, die innerhalb der Ereignisaufbewahrung des Tarifs geendet haben (resolved).

Ein Alarm wird geöffnet, wenn das Ereignis seiner Bedingung eintrifft (screen.offline, eine Gerätezustandsänderung display_disconnected, temperature_high oder on_battery, screen.storage_shortfall, ein hängendes screen.manifest_upgrade, ein screen.status_changed der Fehlerstufe, ein screen.glass_changed mit dem Urteil hängend, leer oder eingefroren), und wird durch das aufhebende Ereignis behoben; crashing ist eine Meldung, kein Alarm. counts.attention zählt offene Alarme, die nicht quittiert, zurückgestellt oder stummgeschaltet sind, also die Zahl, die das Dashboard anzeigt.

Ein Bildschirm, der für einen vom Backend gesendeten Neustart neu startet, öffnet keinen screen_offline- oder display_disconnected-Alarm, bis der Neustart abgeschlossen ist oder zehn Minuten nach dem Senden vergangen sind; eine Bedingung, die dann noch gilt, öffnet ihren Alarm in diesem Moment. Offene Alarme kommen zuerst, die neuesten zuerst; geben Sie next_cursor wie zuvor zurück, um die nächste Seite zu erhalten.

Authentifizierung
projectBearer ODER dashboardSession
Anfrageinhalt
keine
Operations-ID
listAlerts

Parameter

NameSendenErforderlich?Beschreibung
ScreenRig-ProjectÜberschriftoptionalFür eine Veröffentlichung veraltet. Muss mit den JWT-Projektberechtigungen übereinstimmen; fügt Deprecation- und Warning-Header hinzu. Kein Token-Austausch.
FormatAbfrageoptionaljson (Standard) liefert den Bericht als JSON. csv, xlsx und pdf liefern dieselben Zeilen als Dateianhang (jede Seite eines seitenweisen Berichts, bis zu 50000 Zeilen).
StatusAbfrageoptional
screen_idAbfrageoptional
vorAbfrageoptionalnext_cursor der vorherigen Seite.
LimitAbfrageoptional
Anfragevorlage und Antworten
Shell · Anfragevorlage
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/alerts'

Antworten

StatusBedeutungTextkörper und Header
200Eine Seite mit Alarmen.AlertList (application/json)
Standard

Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat.

Problem (application/problem+json)
GET/api/alerts/{id}

Alarm abrufen

Ein Alarm.

Authentifizierung
projectBearer ODER dashboardSession
Anfrageinhalt
keine
Operations-ID
getAlert

Parameter

NameSendenErforderlich?Beschreibung
ScreenRig-ProjectÜberschriftoptionalFür eine Veröffentlichung veraltet. Muss mit den JWT-Projektberechtigungen übereinstimmen; fügt Deprecation- und Warning-Header hinzu. Kein Token-Austausch.
idPfaderforderlich
Anfragevorlage und Antworten
Shell · Anfragevorlage
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/alerts/RESOURCE_ID'

Antworten

StatusBedeutungTextkörper und Header
200Der Alarm.Alert (application/json)
Standard

Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat.

Problem (application/problem+json)
POST/api/alerts/{id}/acknowledge

Alarm quittieren

Quittiert einen offenen Alarm: Jemand kümmert sich darum. Ohne until bleibt er quittiert, bis er behoben ist; mit until (höchstens 30 Tage in der Zukunft) wird er zurückgestellt und braucht zu diesem Zeitpunkt wieder Aufmerksamkeit, wenn er noch offen ist. Solange er quittiert oder zurückgestellt ist, wird die Meldung einer Benachrichtigung dazu, die noch in der Wartezeit ist, übersprungen (acknowledged).

Ein späteres Quittieren ersetzt das frühere. Hängt screen.alert_acknowledged an. Ein behobener Alarm ist alert_not_open.

Authentifizierung
projectBearer ODER dashboardSession
Anfrageinhalt
AlertAcknowledge
Operations-ID
acknowledgeAlert

Parameter

NameSendenErforderlich?Beschreibung
ScreenRig-ProjectÜberschriftoptionalFür eine Veröffentlichung veraltet. Muss mit den JWT-Projektberechtigungen übereinstimmen; fügt Deprecation- und Warning-Header hinzu. Kein Token-Austausch.
idPfaderforderlich
Idempotency-KeyÜberschriftoptionalFür einen frischen Vorgang weglassen. Geben Sie einen Schlüssel an und verwenden Sie ihn erneut, um Wiederholungen zu deduplizieren; die CLI verwaltet Schlüssel automatisch.

Anfrageinhalt-Felder

FeldBeschreibung
until (optional, string)Bis zu diesem Zeitpunkt zurückstellen, höchstens 30 Tage in der Zukunft. Fehlt: quittiert, bis der Alarm behoben ist. format: "date-time"
Anfragevorlage und Antworten
Shell · Anfragevorlage
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/alerts/RESOURCE_ID/acknowledge'

Antworten

StatusBedeutungTextkörper und Header
200Der quittierte Alarm.Alert (application/json)
409alert_not_open.Problem (application/problem+json)
Standard

Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat.

Problem (application/problem+json)
GET/api/alert-mutes

Alarm-Stummschaltungen auflisten

Listet die noch nicht beendeten Stummschaltungen des Projekts auf, die zuerst endende zuerst (höchstens 50).

Authentifizierung
projectBearer ODER dashboardSession
Anfrageinhalt
keine
Operations-ID
listAlertMutes

Parameter

NameSendenErforderlich?Beschreibung
ScreenRig-ProjectÜberschriftoptionalFür eine Veröffentlichung veraltet. Muss mit den JWT-Projektberechtigungen übereinstimmen; fügt Deprecation- und Warning-Header hinzu. Kein Token-Austausch.
Anfragevorlage und Antworten
Shell · Anfragevorlage
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/alert-mutes'

Antworten

StatusBedeutungTextkörper und Header
200Die aktuellen Stummschaltungen des Projekts.AlertMuteList (application/json)
Standard

Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat.

Problem (application/problem+json)
POST/api/alert-mutes

Alarm-Stummschaltung erstellen

Schaltet Bildschirme für Wartungsarbeiten bis zu einem Zeitpunkt stumm, der höchstens 30 Tage in der Zukunft liegt: die in screen_ids genannten Bildschirme und jeden Bildschirm, der zu dem Zeitpunkt, an dem eine Meldung fällig wird, eines der tags trägt. Ihre Alarme werden weiterhin geöffnet und behoben, als stummgeschaltet markiert, und brauchen nie Aufmerksamkeit; die Meldungen jeder Benachrichtigung dazu werden übersprungen (muted).

Eine Organisation hat höchstens 50 aktuelle Stummschaltungen über alle ihre Projekte (alert_mute_limit_reached). Hängt alert_mute.created an.

Authentifizierung
projectBearer ODER dashboardSession
Anfrageinhalt
AlertMuteWrite
Operations-ID
createAlertMute

Parameter

NameSendenErforderlich?Beschreibung
ScreenRig-ProjectÜberschriftoptionalFür eine Veröffentlichung veraltet. Muss mit den JWT-Projektberechtigungen übereinstimmen; fügt Deprecation- und Warning-Header hinzu. Kein Token-Austausch.
Idempotency-KeyÜberschriftoptionalFür einen frischen Vorgang weglassen. Geben Sie einen Schlüssel an und verwenden Sie ihn erneut, um Wiederholungen zu deduplizieren; die CLI verwaltet Schlüssel automatisch.

Anfrageinhalt-Felder

FeldBeschreibung
screen_ids (optional, array)
Tags (optional, ScreenTags)

Flotten-Selektortags, 0 bis 16 eindeutige exakte Tags, die jeweils der Medien-Tag-Grammatik entsprechen. Bei ScreenPatch ersetzt das Array das gesamte Set, und ein leeres Array löscht es; ein doppeltes oder fehlerhaftes Tag ist invalid_request. Das Ändern der Tags erhöht die Bildschirmrevision (If-Match schützt sie) und fügt screen.updated mit details.tags hinzu; die Manifestrevision ändert sich nie.

Tags sind niemals im Laufzeitmanifest und niemals in der Autorisierung enthalten.

until (erforderlich, string)Höchstens 30 Tage in der Zukunft. format: "date-time"
note (optional, string)maxLength: 200
Anfragevorlage und Antworten
Shell · Anfragevorlage
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/alert-mutes'

Antworten

StatusBedeutungTextkörper und Header
201Erstellt.AlertMute (application/json)
409alert_mute_limit_reached oder idempotency_mismatch.Problem (application/problem+json)
Standard

Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat.

Problem (application/problem+json)
LÖSCHEN/api/alert-mutes/{id}

Alarm-Stummschaltung löschen

Beendet eine Stummschaltung sofort und hängt alert_mute.deleted an.

Authentifizierung
projectBearer ODER dashboardSession
Anfrageinhalt
keine
Operations-ID
deleteAlertMute

Parameter

NameSendenErforderlich?Beschreibung
ScreenRig-ProjectÜberschriftoptionalFür eine Veröffentlichung veraltet. Muss mit den JWT-Projektberechtigungen übereinstimmen; fügt Deprecation- und Warning-Header hinzu. Kein Token-Austausch.
idPfaderforderlich
Idempotency-KeyÜberschriftoptionalFür einen frischen Vorgang weglassen. Geben Sie einen Schlüssel an und verwenden Sie ihn erneut, um Wiederholungen zu deduplizieren; die CLI verwaltet Schlüssel automatisch.
Anfragevorlage und Antworten
Shell · Anfragevorlage
curl --request DELETE --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/alert-mutes/RESOURCE_ID'

Antworten

StatusBedeutungTextkörper und Header
204Beendet.kein Körper
Standard

Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat.

Problem (application/problem+json)