Riferimento API

API Registro di audit

Registro di audit: ogni modifica di configurazione con il suo prima e dopo, una catena di hash da verificare ed esportazione in CSV, XLSX e PDF

Riferimento HTTP. Generato dal contratto backend. Esplora gli endpoint qui sotto o scarica OpenAPI.

Questo gruppo ha 4 operazioni, generate da api/openapi.yaml. Filtra per percorso, azione o autenticazione. Ogni endpoint elenca i suoi input; espandilo per vedere un modello di richiesta e i codici di risposta. I modelli richiedono i tuoi valori e un corpo valido secondo lo schema.

Sostituisci i segnaposto maiuscoli con i tuoi valori. Per una richiesta JSON, salva un corpo che corrisponde allo schema in request.json. Gli esempi di cookie usano un cookie jar locale da una sessione autenticata.

Registro di audit: ogni modifica di configurazione con il suo prima e dopo, una catena di hash da verificare ed esportazione in CSV, XLSX e PDF

GET/api/audit

Elenca il registro di audit

Elenca le modifiche di configurazione del progetto, dalla più recente: chi ha cambiato cosa, quando e da quale superficie, con il prima e il dopo a livello di campo, conservate 400 giorni in ogni piano.

Filtrate per actor (id), actor_kind, source, resource_type e resource_id, action (esatta, o un prefisso che termina con *), field (un prefisso di puntatore JSON come /label) e una finestra since/until; paginate con cursor. format csv, xlsx o pdf scrive il registro filtrato in un file con il motore di rendering dei report (una riga per campo modificato, dalla più vecchia, gli ultimi 30 giorni salvo diversa indicazione di since, con la testa della catena e il limite di conservazione nel file perché funga da ancora per audit verify).

I segreti (token, chiavi, password, credenziali di webhook e di sorgenti) appaiono come (redacted); ogni altro valore è il valore memorizzato. Le voci sono scritte dai servizi nella transazione che effettua la modifica; nulla scrive, aggiorna o elimina una voce.

Richiede la capacità del progetto; una sessione della dashboard lo legge come proprietario del progetto, amministratore dell’organizzazione o membro dello staff che segue il progetto. Leggere ed esportare il registro rientra nel registro di audit, che il piano Enterprise include; un progetto il cui piano ne è privo viene rifiutato con feature_not_in_plan (402). Ogni piano registra le proprie modifiche.

Autenticazione
projectBearer O dashboardSession
Corpo della richiesta
nessuno
ID operazione
listAuditLog

Parametri

NomeInviaObbligatorio?Descrizione
ScreenRig-ProjectintestazioneopzionaleDeprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token.
attorequeryopzionaleL’id dell’attore (una persona, un agente o un client di servizio).
actor_kindqueryopzionale
originequeryopzionale
resource_typequeryopzionale
resource_idqueryopzionale
azionequeryopzionaleUn codice azione come screen.update o un prefisso come playlist.*.
fieldqueryopzionaleUn puntatore JSON: le voci che hanno modificato questo membro o uno sottostante, ad es. /label.
daqueryopzionale
fino aqueryopzionale
cursorequeryopzionalenext_cursor della pagina precedente, con gli stessi filtri. Opaco.
limitequeryopzionale
formatoqueryopzionalejson (predefinito) restituisce il report come JSON. csv, xlsx e pdf restituiscono le stesse righe come allegato (ogni pagina di un report a pagine, fino a 50000 righe).
Modello richiesta e risposte
shell · modello richiesta
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/audit'

Risposte

StatoSignificatoCorpo e intestazioni
200Una pagina di voci, o il registro filtrato come file per csv, xlsx e pdf.AuditList (application/json), string (text/csv), string (application/vnd.openxmlformats-officedocument.spreadsheetml.sheet), string (application/pdf)
400

Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore.

Problema (application/problem+json)
402feature_not_in_plan — Il registro di audit fa parte del piano Enterprise; il problema indica la funzione, il piano dell’account e required_plan.Problema (application/problem+json)
404

Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore.

Problema (application/problem+json)
predefinito

Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore.

Problema (application/problem+json)
GET/api/audit/head

Ottieni la testa di audit

La testa della catena di audit del progetto (seq e hash dell’ultima voce concatenata), il limite di conservazione da cui parte la catena e quante voci attendono di essere concatenate. Conserva una testa come ancora e passala in seguito a GET /api/audit/verify per dimostrare che nessuna cronologia precedente è stata riscritta o rimossa.

Fa parte del registro di audit, che il piano Enterprise include; un progetto il cui piano ne è privo viene rifiutato con feature_not_in_plan (402).

Autenticazione
projectBearer O dashboardSession
Corpo della richiesta
nessuno
ID operazione
getAuditHead

Parametri

NomeInviaObbligatorio?Descrizione
ScreenRig-ProjectintestazioneopzionaleDeprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token.
Modello richiesta e risposte
shell · modello richiesta
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/audit/head'

Risposte

StatoSignificatoCorpo e intestazioni
200La testa della catena.AuditHead (application/json)
402feature_not_in_plan — Il registro di audit fa parte del piano Enterprise; il problema indica la funzione, il piano dell’account e required_plan.Problema (application/problem+json)
404

Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore.

Problema (application/problem+json)
predefinito

Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore.

Problema (application/problem+json)
GET/api/audit/verify

Verifica il registro di audit

Ricalcola la catena di hash di audit su un intervallo e segnala cosa non va, se qualcosa non va.

L’hash di ogni voce concatenata viene ricalcolato dal suo contenuto memorizzato, ogni voce deve collegarsi alla precedente, seq deve essere contiguo a partire dal limite di conservazione e l’ultima voce deve essere la testa della catena. anchor (SEQ:HASH da un’esportazione o da head precedente) dimostra inoltre che la voce a quel seq non è cambiata e che la catena non è stata troncata al di sotto.

Una chiamata controlla al massimo 5000 voci; proseguite da next_seq con from_seq. Fa parte del registro di audit, che il piano Enterprise include; un progetto il cui piano ne è privo viene rifiutato con feature_not_in_plan (402).

Autenticazione
projectBearer O dashboardSession
Corpo della richiesta
nessuno
ID operazione
verifyAuditLog

Parametri

NomeInviaObbligatorio?Descrizione
ScreenRig-ProjectintestazioneopzionaleDeprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token.
from_seqqueryopzionalePrima posizione della catena da controllare. Per impostazione predefinita, la più vecchia conservata.
limitequeryopzionale
ancoraqueryopzionaleSEQ:HASH di una testa della catena che avete conservato.
Modello richiesta e risposte
shell · modello richiesta
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/audit/verify'

Risposte

StatoSignificatoCorpo e intestazioni
200Il risultato della verifica.AuditVerifyResult (application/json)
400

Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore.

Problema (application/problem+json)
402feature_not_in_plan — Il registro di audit fa parte del piano Enterprise; il problema indica la funzione, il piano dell’account e required_plan.Problema (application/problem+json)
404

Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore.

Problema (application/problem+json)
predefinito

Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore.

Problema (application/problem+json)
GET/api/audit/{id}

Ottieni una voce di audit

Una voce di audit con le sue modifiche a livello di campo. Fa parte del registro di audit, che il piano Enterprise include; un progetto il cui piano ne è privo viene rifiutato con feature_not_in_plan (402).

Autenticazione
projectBearer O dashboardSession
Corpo della richiesta
nessuno
ID operazione
getAuditEntry

Parametri

NomeInviaObbligatorio?Descrizione
ScreenRig-ProjectintestazioneopzionaleDeprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token.
idpathobbligatorio
Modello richiesta e risposte
shell · modello richiesta
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/audit/RESOURCE_ID'

Risposte

StatoSignificatoCorpo e intestazioni
200La voce.AuditEntry (application/json)
402feature_not_in_plan — Il registro di audit fa parte del piano Enterprise; il problema indica la funzione, il piano dell’account e required_plan.Problema (application/problem+json)
404

Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore.

Problema (application/problem+json)
predefinito

Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore.

Problema (application/problem+json)