Referencia API

API de Registro de auditoría

Registro de auditoría: cada cambio de configuración con su antes y su después, una cadena de hashes que verificar y exportación a CSV, XLSX y PDF

Referencia HTTP. Generada a partir del contrato backend. Explore los endpoints abajo o descargue OpenAPI.

Este grupo tiene 4 operaciones, generadas a partir de api/openapi.yaml. Filtre por ruta, acción o autenticación. Cada endpoint indica sus entradas; despliéguelo para ver una plantilla de solicitud y los códigos de respuesta. Las plantillas necesitan sus propios valores y un cuerpo válido según el esquema.

Reemplace los marcadores en mayúsculas con sus valores. Para una solicitud JSON, guarde un cuerpo que coincida con el esquema en request.json. Los ejemplos de cookies usan un frasco de cookies local de una sesión autenticada.

Registro de auditoría: cada cambio de configuración con su antes y su después, una cadena de hashes que verificar y exportación a CSV, XLSX y PDF

GET/api/audit

Listar el registro de auditoría

Lista los cambios de configuración del proyecto, de los más recientes a los más antiguos: quién cambió qué, cuándo y desde qué superficie, con el antes y el después a nivel de campo, conservados 400 días en todos los planes.

Filtre por actor (id), actor_kind, source, resource_type y resource_id, action (exacta, o un prefijo que termina en *), field (un prefijo de puntero JSON como /label) y una ventana since/until; pagine con cursor. format csv, xlsx o pdf escribe el registro filtrado en un archivo con el motor de generación de informes (una fila por campo modificado, de la más antigua a la más reciente, los últimos 30 días salvo que since indique otra cosa, con la cabecera de la cadena y el límite de retención en el archivo para que sirva de ancla para audit verify).

Los secretos (tokens, claves, contraseñas, credenciales de webhooks y de fuentes) se muestran como (redacted); cualquier otro valor es el valor almacenado. Los servicios escriben las entradas en la transacción que realiza el cambio; nada escribe, actualiza ni elimina una entrada.

Requiere la capacidad del proyecto; una sesión del panel lo lee como propietario del proyecto, administrador de la organización o miembro del personal que observa el proyecto. Leer y exportar el registro corresponde al registro de auditoría, que incluye el plan Enterprise; un proyecto cuyo plan no lo incluye se rechaza con feature_not_in_plan (402). Todos los planes registran sus cambios.

Autenticación
projectBearer O dashboardSession
Cuerpo de la solicitud
ninguno
ID de operación
listAuditLog

Parámetros

NombreEnviar¿Requerido?Descripción
ScreenRig-ProjectencabezadoopcionalObsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.
actorconsultaopcionalEl id del actor (una persona, un agente o un cliente de servicio).
actor_kindconsultaopcional
origenconsultaopcional
resource_typeconsultaopcional
resource_idconsultaopcional
acciónconsultaopcionalUn código de acción como screen.update, o un prefijo como playlist.*.
fieldconsultaopcionalUn puntero JSON: las entradas que cambiaron este miembro o uno situado por debajo, p. ej. /label.
desdeconsultaopcional
hastaconsultaopcional
cursorconsultaopcionalnext_cursor de la página anterior, con los mismos filtros. Opaco.
límiteconsultaopcional
formatoconsultaopcionaljson (por defecto) devuelve el informe como JSON. csv, xlsx y pdf devuelven las mismas filas como archivo adjunto (cada página de un informe paginado, hasta 50000 filas).
Plantilla y respuestas de solicitud
shell · plantilla de solicitud
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/audit'

Respuestas

EstadoSignificadoCuerpo y encabezados
200Una página de entradas, o el registro filtrado como archivo para csv, xlsx y pdf.AuditList (application/json), string (text/csv), string (application/vnd.openxmlformats-officedocument.spreadsheetml.sheet), string (application/pdf)
400

Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.

Problema (application/problem+json)
402feature_not_in_plan — El registro de auditoría forma parte del plan Enterprise; el problema nombra la función, el plan que tiene la cuenta y required_plan.Problema (application/problem+json)
404

Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.

Problema (application/problem+json)
predeterminado

Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.

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

Obtener la cabecera de auditoría

La cabecera de la cadena de auditoría del proyecto (el seq y el hash de la última entrada encadenada), el límite de retención desde el que empieza la cadena y cuántas entradas esperan ser encadenadas. Conserve una cabecera como ancla y pásela más tarde a GET /api/audit/verify para demostrar que no se reescribió ni eliminó ningún historial anterior.

Forma parte del registro de auditoría, que incluye el plan Enterprise; un proyecto cuyo plan no lo incluye se rechaza con feature_not_in_plan (402).

Autenticación
projectBearer O dashboardSession
Cuerpo de la solicitud
ninguno
ID de operación
getAuditHead

Parámetros

NombreEnviar¿Requerido?Descripción
ScreenRig-ProjectencabezadoopcionalObsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.
Plantilla y respuestas de solicitud
shell · plantilla de solicitud
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/audit/head'

Respuestas

EstadoSignificadoCuerpo y encabezados
200La cabecera de la cadena.AuditHead (application/json)
402feature_not_in_plan — El registro de auditoría forma parte del plan Enterprise; el problema nombra la función, el plan que tiene la cuenta y required_plan.Problema (application/problem+json)
404

Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.

Problema (application/problem+json)
predeterminado

Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.

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

Verificar el registro de auditoría

Recalcula la cadena de hashes de auditoría sobre un intervalo e informa de lo que falla, si hay algo.

El hash de cada entrada encadenada se recalcula a partir de su contenido almacenado, cada entrada debe enlazar con la anterior, seq debe ser continuo desde el límite de retención y la última entrada debe ser la cabecera de la cadena. anchor (SEQ:HASH de una exportación o de head anterior) demuestra además que la entrada en ese seq no ha cambiado y que la cadena no se truncó por debajo.

Una llamada comprueba como máximo 5000 entradas; continúe desde next_seq con from_seq. Forma parte del registro de auditoría, que incluye el plan Enterprise; un proyecto cuyo plan no lo incluye se rechaza con feature_not_in_plan (402).

Autenticación
projectBearer O dashboardSession
Cuerpo de la solicitud
ninguno
ID de operación
verifyAuditLog

Parámetros

NombreEnviar¿Requerido?Descripción
ScreenRig-ProjectencabezadoopcionalObsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.
from_seqconsultaopcionalPrimera posición de la cadena que se comprueba. Por defecto, la más antigua conservada.
límiteconsultaopcional
anclaconsultaopcionalSEQ:HASH de una cabecera de cadena que conservó.
Plantilla y respuestas de solicitud
shell · plantilla de solicitud
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/audit/verify'

Respuestas

EstadoSignificadoCuerpo y encabezados
200El resultado de la verificación.AuditVerifyResult (application/json)
400

Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.

Problema (application/problem+json)
402feature_not_in_plan — El registro de auditoría forma parte del plan Enterprise; el problema nombra la función, el plan que tiene la cuenta y required_plan.Problema (application/problem+json)
404

Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.

Problema (application/problem+json)
predeterminado

Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.

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

Obtener una entrada de auditoría

Una entrada de auditoría con sus cambios a nivel de campo. Forma parte del registro de auditoría, que incluye el plan Enterprise; un proyecto cuyo plan no lo incluye se rechaza con feature_not_in_plan (402).

Autenticación
projectBearer O dashboardSession
Cuerpo de la solicitud
ninguno
ID de operación
getAuditEntry

Parámetros

NombreEnviar¿Requerido?Descripción
ScreenRig-ProjectencabezadoopcionalObsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token.
idrutarequerido
Plantilla y respuestas de solicitud
shell · plantilla de solicitud
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/audit/RESOURCE_ID'

Respuestas

EstadoSignificadoCuerpo y encabezados
200La entrada.AuditEntry (application/json)
402feature_not_in_plan — El registro de auditoría forma parte del plan Enterprise; el problema nombra la función, el plan que tiene la cuenta y required_plan.Problema (application/problem+json)
404

Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.

Problema (application/problem+json)
predeterminado

Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.

Problema (application/problem+json)