OpenAPI YAMLOpenAPI JSONProbleme YAMLAPI-Überblick
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
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.
Parameter
| Name | Senden | Erforderlich? | Beschreibung |
|---|---|---|---|
| ScreenRig-Project | Überschrift | optional | Für eine Veröffentlichung veraltet. Muss mit den JWT-Projektberechtigungen übereinstimmen; fügt Deprecation- und Warning-Header hinzu. Kein Token-Austausch. |
| Format | Abfrage | optional | json (Standard) liefert den Bericht als JSON. csv, xlsx und pdf liefern dieselben Zeilen als Dateianhang (jede Seite eines seitenweisen Berichts, bis zu 50000 Zeilen). |
| Status | Abfrage | optional | |
| screen_id | Abfrage | optional | |
| vor | Abfrage | optional | next_cursor der vorherigen Seite. |
| Limit | Abfrage | optional |
Anfragevorlage und Antworten
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/alerts'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Eine 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) |
Alarm abrufen
Ein Alarm.
Parameter
| Name | Senden | Erforderlich? | Beschreibung |
|---|---|---|---|
| ScreenRig-Project | Überschrift | optional | Für eine Veröffentlichung veraltet. Muss mit den JWT-Projektberechtigungen übereinstimmen; fügt Deprecation- und Warning-Header hinzu. Kein Token-Austausch. |
| id | Pfad | erforderlich |
Anfragevorlage und Antworten
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/alerts/RESOURCE_ID'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Der 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) |
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.
Parameter
| Name | Senden | Erforderlich? | Beschreibung |
|---|---|---|---|
| ScreenRig-Project | Überschrift | optional | Für eine Veröffentlichung veraltet. Muss mit den JWT-Projektberechtigungen übereinstimmen; fügt Deprecation- und Warning-Header hinzu. Kein Token-Austausch. |
| id | Pfad | erforderlich | |
| Idempotency-Key | Überschrift | optional | Fü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
| Feld | Beschreibung |
|---|---|
| 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
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
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Der quittierte Alarm. | Alert (application/json) |
| 409 | alert_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) |
Alarm-Stummschaltungen auflisten
Listet die noch nicht beendeten Stummschaltungen des Projekts auf, die zuerst endende zuerst (höchstens 50).
Parameter
| Name | Senden | Erforderlich? | Beschreibung |
|---|---|---|---|
| ScreenRig-Project | Überschrift | optional | Für eine Veröffentlichung veraltet. Muss mit den JWT-Projektberechtigungen übereinstimmen; fügt Deprecation- und Warning-Header hinzu. Kein Token-Austausch. |
Anfragevorlage und Antworten
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/alert-mutes'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Die 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) |
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.
Parameter
| Name | Senden | Erforderlich? | Beschreibung |
|---|---|---|---|
| ScreenRig-Project | Überschrift | optional | Für eine Veröffentlichung veraltet. Muss mit den JWT-Projektberechtigungen übereinstimmen; fügt Deprecation- und Warning-Header hinzu. Kein Token-Austausch. |
| Idempotency-Key | Überschrift | optional | Fü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
| Feld | Beschreibung |
|---|---|
| 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
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
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 201 | Erstellt. | AlertMute (application/json) |
| 409 | alert_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) |
Alarm-Stummschaltung löschen
Beendet eine Stummschaltung sofort und hängt alert_mute.deleted an.
Parameter
| Name | Senden | Erforderlich? | Beschreibung |
|---|---|---|---|
| ScreenRig-Project | Überschrift | optional | Für eine Veröffentlichung veraltet. Muss mit den JWT-Projektberechtigungen übereinstimmen; fügt Deprecation- und Warning-Header hinzu. Kein Token-Austausch. |
| id | Pfad | erforderlich | |
| Idempotency-Key | Überschrift | optional | Fü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
curl --request DELETE --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/alert-mutes/RESOURCE_ID'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 204 | Beendet. | 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) |