API-Referenz

Audit-Protokoll-API

Audit-Protokoll: jede Konfigurationsänderung mit Vorher und Nachher, eine Hash-Kette zum Verifizieren und Export als CSV, XLSX und PDF

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

Diese Gruppe hat 4 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.

Audit-Protokoll: jede Konfigurationsänderung mit Vorher und Nachher, eine Hash-Kette zum Verifizieren und Export als CSV, XLSX und PDF

GET/api/audit

Audit-Protokoll auflisten

Listet die Konfigurationsänderungen des Projekts auf, neueste zuerst: wer was wann und von welcher Oberfläche geändert hat, mit dem Vorher und Nachher auf Feldebene, in jedem Tarif 400 Tage aufbewahrt.

Nach actor (id), actor_kind, source, resource_type und resource_id, action (exakt oder ein Präfix, das auf * endet), field (ein JSON-Pointer-Präfix wie /label) und einem since/until-Zeitfenster filtern; mit cursor blättern. format csv, xlsx oder pdf schreibt das gefilterte Protokoll mit dem Berichts-Renderer als Datei (eine Zeile pro geändertem Feld, älteste zuerst, die letzten 30 Tage, sofern since nichts anderes angibt, Kettenkopf und Aufbewahrungsgrenze in der Datei, damit sie als Anker für audit verify dient).

Geheimnisse (Token, Schlüssel, Passwörter, Webhook- und Quellen-Zugangsdaten) erscheinen als (redacted); jeder andere Wert ist der gespeicherte Wert. Einträge werden von den Diensten in der Transaktion geschrieben, die die Änderung vornimmt; nichts schreibt, aktualisiert oder löscht einen Eintrag.

Erfordert die Projektberechtigung; eine Dashboard-Sitzung liest es als Projektinhaber, Organisationsadministrator oder als Mitarbeiter, der das Projekt mitverfolgt. Das Lesen und Exportieren des Protokolls fällt unter das Audit-Protokoll, das der Enterprise-Plan enthält; ein Projekt, dessen Plan dies nicht enthält, wird mit feature_not_in_plan (402) abgelehnt. In jedem Plan werden die Änderungen aufgezeichnet.

Authentifizierung
projectBearer ODER dashboardSession
Anfrageinhalt
keine
Operations-ID
listAuditLog

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.
AkteurAbfrageoptionalDie ID des Akteurs (einer Person, eines Agenten oder eines Service-Clients).
actor_kindAbfrageoptional
QuelleAbfrageoptional
resource_typeAbfrageoptional
resource_idAbfrageoptional
AktionAbfrageoptionalEin Aktionscode wie screen.update oder ein Präfix wie playlist.*.
fieldAbfrageoptionalEin JSON-Pointer: Einträge, die dieses Mitglied oder ein darunterliegendes geändert haben, z. B. /label.
seitAbfrageoptional
bisAbfrageoptional
CursorAbfrageoptionalnext_cursor der vorherigen Seite mit denselben Filtern. Opaque.
LimitAbfrageoptional
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).
Anfragevorlage und Antworten
Shell · Anfragevorlage
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/audit'

Antworten

StatusBedeutungTextkörper und Header
200Eine Seite mit Einträgen oder das gefilterte Protokoll als Datei für csv, xlsx und pdf.AuditList (application/json), string (text/csv), string (application/vnd.openxmlformats-officedocument.spreadsheetml.sheet), string (application/pdf)
400

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)
402feature_not_in_plan — Das Audit-Protokoll ist Teil des Enterprise-Plans; das Problem nennt die Funktion, den Plan, den das Konto hat, und required_plan.Problem (application/problem+json)
404

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)
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/audit/head

Audit-Kettenkopf abrufen

Der Kopf der Audit-Kette des Projekts (seq und hash des letzten verketteten Eintrags), die Aufbewahrungsuntergrenze, ab der die Kette beginnt, und wie viele Einträge noch auf die Verkettung warten. Bewahren Sie einen Kopf als Anker auf und übergeben Sie ihn später an GET /api/audit/verify, um zu belegen, dass davor keine Historie umgeschrieben oder entfernt wurde.

Teil des Audit-Protokolls, das der Enterprise-Plan enthält; ein Projekt, dessen Plan dies nicht enthält, wird mit feature_not_in_plan (402) abgelehnt.

Authentifizierung
projectBearer ODER dashboardSession
Anfrageinhalt
keine
Operations-ID
getAuditHead

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/audit/head'

Antworten

StatusBedeutungTextkörper und Header
200Der Kettenkopf.AuditHead (application/json)
402feature_not_in_plan — Das Audit-Protokoll ist Teil des Enterprise-Plans; das Problem nennt die Funktion, den Plan, den das Konto hat, und required_plan.Problem (application/problem+json)
404

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)
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/audit/verify

Audit-Protokoll verifizieren

Berechnet die Audit-Hash-Kette über einen Bereich neu und meldet, was falsch ist, falls etwas falsch ist.

Der Hash jedes verketteten Eintrags wird aus seinem gespeicherten Inhalt neu berechnet, jeder Eintrag muss mit dem vorherigen verbunden sein, seq muss ab der Aufbewahrungsgrenze lückenlos sein, und der letzte Eintrag muss der Kettenkopf sein. anchor (SEQ:HASH aus einem früheren Export oder von head) beweist zusätzlich, dass der Eintrag an diesem seq unverändert ist und die Kette nicht darunter gekürzt wurde.

Ein Aufruf prüft höchstens 5000 Einträge; mit from_seq ab next_seq fortsetzen. Teil des Audit-Protokolls, das der Enterprise-Plan enthält; ein Projekt, dessen Plan dies nicht enthält, wird mit feature_not_in_plan (402) abgelehnt.

Authentifizierung
projectBearer ODER dashboardSession
Anfrageinhalt
keine
Operations-ID
verifyAuditLog

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.
from_seqAbfrageoptionalErste zu prüfende Kettenposition. Standard ist die älteste aufbewahrte.
LimitAbfrageoptional
AnkerAbfrageoptionalSEQ:HASH eines Kettenkopfs, den Sie aufbewahrt haben.
Anfragevorlage und Antworten
Shell · Anfragevorlage
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/audit/verify'

Antworten

StatusBedeutungTextkörper und Header
200Das Ergebnis der Verifizierung.AuditVerifyResult (application/json)
400

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)
402feature_not_in_plan — Das Audit-Protokoll ist Teil des Enterprise-Plans; das Problem nennt die Funktion, den Plan, den das Konto hat, und required_plan.Problem (application/problem+json)
404

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)
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/audit/{id}

Audit-Eintrag abrufen

Ein Audit-Eintrag mit seinen Änderungen auf Feldebene. Teil des Audit-Protokolls, das der Enterprise-Plan enthält; ein Projekt, dessen Plan dies nicht enthält, wird mit feature_not_in_plan (402) abgelehnt.

Authentifizierung
projectBearer ODER dashboardSession
Anfrageinhalt
keine
Operations-ID
getAuditEntry

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/audit/RESOURCE_ID'

Antworten

StatusBedeutungTextkörper und Header
200Der Eintrag.AuditEntry (application/json)
402feature_not_in_plan — Das Audit-Protokoll ist Teil des Enterprise-Plans; das Problem nennt die Funktion, den Plan, den das Konto hat, und required_plan.Problem (application/problem+json)
404

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)
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)