Referência da API

API de Registro de auditoria

Registro de auditoria: cada alteração de configuração com seu antes e depois, uma cadeia de hashes para verificar e exportação em CSV, XLSX e PDF

Referência HTTP. Gerada a partir do contrato backend. Navegue pelos endpoints abaixo ou baixe o OpenAPI.

Este grupo tem 4 operações, geradas a partir de api/openapi.yaml. Filtre por caminho, ação ou autenticação. Cada endpoint lista suas entradas; expanda-o para ver um modelo de solicitação e os códigos de resposta. Os modelos precisam de seus próprios valores e de um corpo válido conforme o esquema.

Substitua os espaços reservados em maiúsculas pelos seus valores. Para uma solicitação JSON, salve um corpo que corresponda ao esquema em request.json. Exemplos de cookies usam um jar local de cookies de uma sessão autenticada.

Registro de auditoria: cada alteração de configuração com seu antes e depois, uma cadeia de hashes para verificar e exportação em CSV, XLSX e PDF

GET/api/audit

Listar o registro de auditoria

Lista as alterações de configuração do projeto, das mais recentes para as mais antigas: quem alterou o quê, quando e por qual superfície, com o antes e o depois no nível do campo, mantidas por 400 dias em todos os planos.

Filtre por actor (id), actor_kind, source, resource_type e resource_id, action (exata ou um prefixo terminado em *), field (um prefixo de ponteiro JSON como /label) e uma janela since/until; pagine com cursor. format csv, xlsx ou pdf grava o registro filtrado em um arquivo com o renderizador de relatórios (uma linha por campo alterado, da mais antiga para a mais recente, os últimos 30 dias, a menos que since diga outra coisa, com o cabeçalho da cadeia e o limite de retenção no arquivo para que ele sirva de âncora para audit verify).

Segredos (tokens, chaves, senhas, credenciais de webhooks e de fontes) aparecem como (redacted); qualquer outro valor é o valor armazenado. As entradas são gravadas pelos serviços na transação que faz a alteração; nada grava, atualiza ou exclui uma entrada.

Exige a capacidade do projeto; uma sessão do painel o lê como proprietário do projeto, administrador da organização ou membro da equipe que acompanha o projeto. Ler e exportar o registro é o recurso de registro de auditoria, que o plano Enterprise inclui; um projeto cujo plano não o inclui é recusado com feature_not_in_plan (402). Todo plano registra as suas alterações.

Autenticação
projectBearer OU dashboardSession
Corpo da solicitação
nenhum
ID da operação
listAuditLog

Parâmetros

NomeEnviarObrigatório?Descrição
ScreenRig-ProjectcabeçalhoopcionalObsoleto por uma versão. Deve ser consistente com as concessões de projetos JWT; adiciona cabeçalhos Deprecation e Warning. Sem troca de token.
atorconsultaopcionalO id do ator (uma pessoa, um agente ou um cliente de serviço).
actor_kindconsultaopcional
origemconsultaopcional
resource_typeconsultaopcional
resource_idconsultaopcional
açãoconsultaopcionalUm código de ação como screen.update ou um prefixo como playlist.*.
fieldconsultaopcionalUm ponteiro JSON: entradas que alteraram este membro ou um membro abaixo dele, p. ex. /label.
desdeconsultaopcional
atéconsultaopcional
cursorconsultaopcionalnext_cursor da página anterior, com os mesmos filtros. Opaco.
limiteconsultaopcional
formatoconsultaopcionaljson (padrão) retorna o relatório como JSON. csv, xlsx e pdf retornam as mesmas linhas como anexo (cada página de um relatório paginado, até 50000 linhas).
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/audit'

Respostas

StatusSignificadoCorpo e cabeçalhos
200Uma página de entradas ou o registro filtrado como arquivo para csv, xlsx e pdf.AuditList (application/json), string (text/csv), string (application/vnd.openxmlformats-officedocument.spreadsheetml.sheet), string (application/pdf)
400

Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.

Problema (application/problem+json)
402feature_not_in_plan — O registro de auditoria faz parte do plano Enterprise; o problema nomeia o recurso, o plano em que a conta está e required_plan.Problema (application/problem+json)
404

Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.

Problema (application/problem+json)
padrão

Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.

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

Obter o cabeçalho de auditoria

O cabeçalho da cadeia de auditoria do projeto (o seq e o hash da última entrada encadeada), o piso de retenção a partir do qual a cadeia começa e quantas entradas aguardam encadeamento. Guarde um cabeçalho como âncora e passe-o depois a GET /api/audit/verify para provar que nenhum histórico anterior foi reescrito ou removido.

Faz parte do registro de auditoria, que o plano Enterprise inclui; um projeto cujo plano não o inclui é recusado com feature_not_in_plan (402).

Autenticação
projectBearer OU dashboardSession
Corpo da solicitação
nenhum
ID da operação
getAuditHead

Parâmetros

NomeEnviarObrigatório?Descrição
ScreenRig-ProjectcabeçalhoopcionalObsoleto por uma versão. Deve ser consistente com as concessões de projetos JWT; adiciona cabeçalhos Deprecation e Warning. Sem troca de token.
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/audit/head'

Respostas

StatusSignificadoCorpo e cabeçalhos
200O cabeçalho da cadeia.AuditHead (application/json)
402feature_not_in_plan — O registro de auditoria faz parte do plano Enterprise; o problema nomeia o recurso, o plano em que a conta está e required_plan.Problema (application/problem+json)
404

Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.

Problema (application/problem+json)
padrão

Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.

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

Verificar o registro de auditoria

Recalcula a cadeia de hashes de auditoria em um intervalo e informa o que está errado, se houver.

O hash de cada entrada encadeada é recalculado a partir do conteúdo armazenado, cada entrada deve se ligar à anterior, seq deve ser contíguo a partir do limite de retenção e a última entrada deve ser o cabeçalho da cadeia. anchor (SEQ:HASH de uma exportação ou de head anterior) prova ainda que a entrada nesse seq não mudou e que a cadeia não foi truncada abaixo dele.

Uma chamada verifica no máximo 5000 entradas; continue a partir de next_seq com from_seq. Faz parte do registro de auditoria, que o plano Enterprise inclui; um projeto cujo plano não o inclui é recusado com feature_not_in_plan (402).

Autenticação
projectBearer OU dashboardSession
Corpo da solicitação
nenhum
ID da operação
verifyAuditLog

Parâmetros

NomeEnviarObrigatório?Descrição
ScreenRig-ProjectcabeçalhoopcionalObsoleto por uma versão. Deve ser consistente com as concessões de projetos JWT; adiciona cabeçalhos Deprecation e Warning. Sem troca de token.
from_seqconsultaopcionalPrimeira posição da cadeia a verificar. Por padrão, a mais antiga mantida.
limiteconsultaopcional
âncoraconsultaopcionalSEQ:HASH de um cabeçalho de cadeia que você guardou.
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/audit/verify'

Respostas

StatusSignificadoCorpo e cabeçalhos
200O resultado da verificação.AuditVerifyResult (application/json)
400

Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.

Problema (application/problem+json)
402feature_not_in_plan — O registro de auditoria faz parte do plano Enterprise; o problema nomeia o recurso, o plano em que a conta está e required_plan.Problema (application/problem+json)
404

Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.

Problema (application/problem+json)
padrão

Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.

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

Obter uma entrada de auditoria

Uma entrada de auditoria com suas alterações no nível do campo. Faz parte do registro de auditoria, que o plano Enterprise inclui; um projeto cujo plano não o inclui é recusado com feature_not_in_plan (402).

Autenticação
projectBearer OU dashboardSession
Corpo da solicitação
nenhum
ID da operação
getAuditEntry

Parâmetros

NomeEnviarObrigatório?Descrição
ScreenRig-ProjectcabeçalhoopcionalObsoleto por uma versão. Deve ser consistente com as concessões de projetos JWT; adiciona cabeçalhos Deprecation e Warning. Sem troca de token.
idcaminhoobrigatório
Modelo e respostas da solicitação
shell · modelo de requisição
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/audit/RESOURCE_ID'

Respostas

StatusSignificadoCorpo e cabeçalhos
200A entrada.AuditEntry (application/json)
402feature_not_in_plan — O registro de auditoria faz parte do plano Enterprise; o problema nomeia o recurso, o plano em que a conta está e required_plan.Problema (application/problem+json)
404

Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.

Problema (application/problem+json)
padrão

Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.

Problema (application/problem+json)