Referência da API/Referência
Índice de outras rotas /api/v1
Rotas existentes que não têm secção própria acima. «Chave» = chave de API do tenant; «Chave/sessão» = qualquer das duas; «Sessão» = usada apenas pela interface (não é API pública). O contrato dos campos de cada recurso é o do módulo correspondente na UI; este índice só regista o que existe e como se autentica.
| Rota | Métodos | Autenticação | Notas |
|---|---|---|---|
/alerts |
GET | Sessão | Alertas do dashboard; 30 req/min |
/assets | POST | Chave | Importação de ativos |
/audit-log · /audit-log/stats · /audit-log/export |
GET | Sessão | Consulta, estatística e exportação do audit log; entradas e CSV com seq, prevHash e selfHash |
/audit-log/proof |
GET | Sessão (ADMIN, AUDITOR) | Prova de integridade do audit log em ZIP (ver «Registo de auditoria, prova de integridade»); 5 pedidos/min por organização |
/audit-plans · /audit-plans/:id |
GET, POST · GET, PUT, DELETE | Chave/sessão | Planos de auditoria |
/audit-plans/:id/findings · /audit-plans/:id/findings/:fid |
POST · PUT, DELETE | Chave/sessão | Achados de auditoria |
/audit-tokens · /audit-tokens/:id |
GET, POST · PATCH, DELETE | Sessão | Tokens do auditor externo; exige permissão para convidar utilizadores (ADMIN) |
/bcm-tests · /bcm-tests/:id |
GET, POST · GET, DELETE | Chave/sessão | Testes de continuidade |
/branding |
GET | Sessão | Marca do tenant |
/breach-notifications · /:id |
GET, POST · GET, PUT, DELETE | Chave | Violações de dados (ver “Violações de dados”; prazos contam de awareAt ?? detectedAt) |
/business-functions · /:id · /:id/processes |
GET, POST · GET, PUT, DELETE · GET, POST | Chave | Funções e processos de negócio (BIA) |
/capa · /capa/:id |
GET, POST · GET, PUT, DELETE | Chave/sessão | Ações corretivas |
/compliance-score · /coverage · /gaps · /policies |
GET | Chave | Conformidade, cobertura, gaps e políticas (leitura) |
/gaps/analyze · /knowledge/index |
POST | Chave | Análise de gaps e indexação na base de conhecimento (IA) |
/contracts · /:id |
GET, POST · GET, PUT, DELETE | Chave | Contratos (herdam a entidade do fornecedor) |
/control-exceptions · /:id |
GET, POST · GET, DELETE | Chave/sessão | Exceções de controlo |
/control-exceptions/:id/approve · /reject |
POST | Sessão | Aprovação / rejeição, sujeitas a segregação de funções (SoD) |
/controls · /controls/:id/mappings |
GET · GET, POST, DELETE | Chave/sessão | Catálogo de controlos e mapeamentos |
/control-tests · /:id |
GET, POST · GET, PATCH, DELETE | Chave/sessão | Testes de controlo (ver “Testes de controlo”) |
/customer-satisfaction · /:id |
GET, POST · GET, PUT, DELETE | Chave | Satisfação de clientes (ISO 9001) |
/dpia · /:id |
GET, POST · GET, PUT, DELETE | Chave | Avaliações de impacto (RGPD Art. 35); o PUT só edita em DRAFT e não muda o estado (ver “DPIA”) |
/entities |
GET | Sessão | Entidades acessíveis ao utilizador |
/environmental-aspects · /:id |
GET, POST · GET, PUT, DELETE | Chave | Aspetos ambientais (ISO 14001) |
/evidence · /:id · /:id/ocr |
GET, POST · GET, DELETE · POST | Chave/sessão | Evidências e OCR; o POST regista UPLOAD ou CREATE no audit log |
/interested-parties · /:id |
GET, POST · GET, PUT, DELETE | Chave | Partes interessadas |
/legal-requirements · /:id |
GET, POST · GET, PUT, DELETE | Chave | Requisitos legais |
/minutes/import · /minutes/:id/signature-upload |
POST | Sessão | Importação de atas e carregamento de assinatura |
/monitoring/backup-report |
POST | Chave (scope típico: esta rota) | O script de backups reporta o estado dos alvos; exige uma integração BACKUP_REPORT configurada (409 caso contrário); 60 req/min |
/notifications |
GET, PATCH | Sessão | Notificações do utilizador |
/organizational-context · /:id |
GET, POST · GET, PUT, DELETE | Chave | Contexto da organização |
/quality-objectives · /:id |
GET, POST · GET, PUT, DELETE | Chave | Objetivos da qualidade |
/raci · /:id · /:id/assignments · /:id/assignments/:assignmentId |
GET, POST · GET, DELETE · POST · DELETE | Chave | Matrizes RACI |
/regulatory-updates · /:id |
GET, POST · GET, PATCH, DELETE · GET | Chave | Atualizações regulatórias |
/reports/executive |
GET | Sessão | Relatório executivo |
/risks/:id/treatment-actions (+ /:actionId, /suggest) |
GET, POST · PATCH, DELETE · POST | Sessão | Plano de tratamento de riscos |
/ropa |
GET, POST | Sessão | Registo de atividades de tratamento (RGPD Art. 30) |
/search |
GET | Sessão | Pesquisa global |
/tasks |
GET, POST | Chave | Tarefas |
/integrations/slack · /integrations/teams |
GET, POST, DELETE | Sessão | Configuração de notificações Slack / Teams |
/integrations/wazuh/agents · /integrations/wazuh/alert-rollups |
POST | x-etershield-key + x-tenant-id |
Inventário de agentes e agregados diários de alertas (nunca alertas em cru) |
/wazuh/enroll |
POST | Token de enrollment de curta duração | Broker de enrollment de agentes; devolve a chave do agente uma única vez; 401 se o token estiver inválido, expirado ou esgotado |
/admin/data-delete |
DELETE | Sessão ADMIN | Eliminação de todos os dados GRC do tenant (RGPD Art. 17); body { confirm, reason }; irreversível; limitada a 1 por dia |
/sign/cmd |
POST, PUT | Sessão | Assinatura com Chave Móvel Digital |
Em breveEsta página estará disponível em breve.