Référence API

API Journal d’audit

Journal d’audit : chaque modification de configuration avec son avant et son après, une chaîne d’empreintes à vérifier, et exportation CSV, XLSX et PDF

Référence HTTP. Générée à partir du contrat backend. Parcourez les points de terminaison ci-dessous ou téléchargez OpenAPI.

Ce groupe compte 4 opérations, générées à partir de api/openapi.yaml. Filtrez par chemin, action ou authentification. Chaque point de terminaison liste ses entrées ; développez-le pour voir un modèle de requête et les codes de réponse. Les modèles demandent vos propres valeurs et un corps conforme au schéma.

Remplacez les espaces réservés en majuscules par vos valeurs. Pour une requête JSON, enregistrez un corps correspondant au schéma dans request.json. Les exemples de cookies utilisent un pot à cookies local issu d’une session authentifiée.

Journal d’audit : chaque modification de configuration avec son avant et son après, une chaîne d’empreintes à vérifier, et exportation CSV, XLSX et PDF

GET/api/audit

Lister le journal d’audit

Liste les modifications de configuration du projet, de la plus récente à la plus ancienne : qui a modifié quoi, quand, depuis quelle surface, avec l’avant et l’après au niveau du champ, conservées 400 jours quel que soit le forfait.

Filtrer par actor (id), actor_kind, source, resource_type et resource_id, action (exacte, ou un préfixe se terminant par *), field (un préfixe de pointeur JSON tel que /label) et une fenêtre since/until ; paginer avec cursor. format csv, xlsx ou pdf écrit le journal filtré dans un fichier avec le moteur de rendu des rapports (une ligne par champ modifié, de la plus ancienne à la plus récente, les 30 derniers jours sauf indication contraire de since, la tête de chaîne et le plancher de conservation dans le fichier pour qu’il serve d’ancre à audit verify).

Les secrets (jetons, clés, mots de passe, identifiants de webhooks et de sources) s’affichent comme (redacted) ; toute autre valeur est la valeur stockée. Les entrées sont écrites par les services dans la transaction qui effectue la modification ; rien n’écrit, ne met à jour ni ne supprime une entrée.

Nécessite la capacité du projet ; une session du tableau de bord le lit en tant que propriétaire du projet, administrateur de l’organisation ou membre du personnel qui observe le projet. La lecture et l’exportation du journal relèvent du journal d’audit, que le forfait Enterprise inclut ; un projet dont le forfait n’inclut pas cette fonctionnalité est refusé avec feature_not_in_plan (402). Chaque forfait consigne ses modifications.

Authentification
projectBearer OU dashboardSession
Corps de la requête
aucun
ID d’opération
listAuditLog

Paramètres

NomEnvoyerRequis ?Description
ScreenRig-Projecten-têteoptionnelObsolète pour une version. Doit être cohérent avec les droits JWT des projets ; ajoute les en-têtes Deprecation et Warning. Pas d’échange de jeton.
acteurrequêteoptionnelL’identifiant de l’acteur (une personne, un agent ou un client de service).
actor_kindrequêteoptionnel
sourcerequêteoptionnel
resource_typerequêteoptionnel
resource_idrequêteoptionnel
actionrequêteoptionnelUn code d’action tel que screen.update, ou un préfixe tel que playlist.*.
fieldrequêteoptionnelUn pointeur JSON : les entrées qui ont modifié ce membre ou un membre situé en dessous, p. ex. /label.
depuisrequêteoptionnel
jusqu’àrequêteoptionnel
curseurrequêteoptionnelnext_cursor de la page précédente, avec les mêmes filtres. Opaque.
limiterequêteoptionnel
formatrequêteoptionneljson (par défaut) renvoie le rapport en JSON. csv, xlsx et pdf renvoient les mêmes lignes en pièce jointe (chaque page d'un rapport paginé, jusqu'à 50000 lignes).
Modèle de requête et réponses
shell · modèle de requête
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/audit'

Réponses

StatutSensCorps et en-têtes
200Une page d’entrées, ou le journal filtré sous forme de fichier pour csv, xlsx et pdf.AuditList (application/json), string (text/csv), string (application/vnd.openxmlformats-officedocument.spreadsheetml.sheet), string (application/pdf)
400

Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique.

Problème (application/problem+json)
402feature_not_in_plan — Le journal d’audit fait partie du forfait Enterprise ; le problème nomme la fonctionnalité, le forfait du compte et required_plan.Problème (application/problem+json)
404

Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique.

Problème (application/problem+json)
par défaut

Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique.

Problème (application/problem+json)
GET/api/audit/head

Obtenir la tête d’audit

La tête de la chaîne d’audit du projet (le seq et le hash de la dernière entrée chaînée), le plancher de rétention d’où part la chaîne, et le nombre d’entrées en attente d’être chaînées. Conservez une tête comme ancre et transmettez-la plus tard à GET /api/audit/verify pour prouver qu’aucun historique antérieur n’a été réécrit ni supprimé.

Fait partie du journal d’audit, que le forfait Enterprise inclut ; un projet dont le forfait n’inclut pas cette fonctionnalité est refusé avec feature_not_in_plan (402).

Authentification
projectBearer OU dashboardSession
Corps de la requête
aucun
ID d’opération
getAuditHead

Paramètres

NomEnvoyerRequis ?Description
ScreenRig-Projecten-têteoptionnelObsolète pour une version. Doit être cohérent avec les droits JWT des projets ; ajoute les en-têtes Deprecation et Warning. Pas d’échange de jeton.
Modèle de requête et réponses
shell · modèle de requête
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/audit/head'

Réponses

StatutSensCorps et en-têtes
200La tête de chaîne.AuditHead (application/json)
402feature_not_in_plan — Le journal d’audit fait partie du forfait Enterprise ; le problème nomme la fonctionnalité, le forfait du compte et required_plan.Problème (application/problem+json)
404

Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique.

Problème (application/problem+json)
par défaut

Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique.

Problème (application/problem+json)
GET/api/audit/verify

Vérifier le journal d’audit

Recalcule la chaîne d’empreintes d’audit sur une plage et signale ce qui ne va pas, le cas échéant.

L’empreinte de chaque entrée chaînée est recalculée à partir de son contenu stocké, chaque entrée doit être liée à la précédente, seq doit être continu à partir du plancher de conservation, et la dernière entrée doit être la tête de chaîne. anchor (SEQ:HASH d’une exportation ou de head antérieure) prouve en plus que l’entrée à ce seq est inchangée et que la chaîne n’a pas été tronquée en deçà.

Un appel vérifie au plus 5000 entrées ; poursuivre depuis next_seq avec from_seq. Fait partie du journal d’audit, que le forfait Enterprise inclut ; un projet dont le forfait n’inclut pas cette fonctionnalité est refusé avec feature_not_in_plan (402).

Authentification
projectBearer OU dashboardSession
Corps de la requête
aucun
ID d’opération
verifyAuditLog

Paramètres

NomEnvoyerRequis ?Description
ScreenRig-Projecten-têteoptionnelObsolète pour une version. Doit être cohérent avec les droits JWT des projets ; ajoute les en-têtes Deprecation et Warning. Pas d’échange de jeton.
from_seqrequêteoptionnelPremière position de la chaîne à vérifier. Par défaut, la plus ancienne conservée.
limiterequêteoptionnel
ancrerequêteoptionnelSEQ:HASH d’une tête de chaîne que vous avez conservée.
Modèle de requête et réponses
shell · modèle de requête
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/audit/verify'

Réponses

StatutSensCorps et en-têtes
200Le résultat de la vérification.AuditVerifyResult (application/json)
400

Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique.

Problème (application/problem+json)
402feature_not_in_plan — Le journal d’audit fait partie du forfait Enterprise ; le problème nomme la fonctionnalité, le forfait du compte et required_plan.Problème (application/problem+json)
404

Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique.

Problème (application/problem+json)
par défaut

Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique.

Problème (application/problem+json)
GET/api/audit/{id}

Obtenir une entrée d’audit

Une entrée d’audit avec ses modifications au niveau du champ. Fait partie du journal d’audit, que le forfait Enterprise inclut ; un projet dont le forfait n’inclut pas cette fonctionnalité est refusé avec feature_not_in_plan (402).

Authentification
projectBearer OU dashboardSession
Corps de la requête
aucun
ID d’opération
getAuditEntry

Paramètres

NomEnvoyerRequis ?Description
ScreenRig-Projecten-têteoptionnelObsolète pour une version. Doit être cohérent avec les droits JWT des projets ; ajoute les en-têtes Deprecation et Warning. Pas d’échange de jeton.
idcheminobligatoire
Modèle de requête et réponses
shell · modèle de requête
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/audit/RESOURCE_ID'

Réponses

StatutSensCorps et en-têtes
200L’entrée.AuditEntry (application/json)
402feature_not_in_plan — Le journal d’audit fait partie du forfait Enterprise ; le problème nomme la fonctionnalité, le forfait du compte et required_plan.Problème (application/problem+json)
404

Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique.

Problème (application/problem+json)
par défaut

Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique.

Problème (application/problem+json)