API reference/Reference
Index of Other /api/v1 Routes
Existing routes that do not have their own section above. "Key" = tenant API key; "Key/session" = either; "Session" = used by the interface only (not public API). The field contract of each resource is that of the corresponding module in the UI; this index only records what exists and how it is authenticated.
| Route | Methods | Authentication | Notes |
|---|---|---|---|
/alerts |
GET | Session | Dashboard alerts; 30 req/min |
/assets | POST | Key | Asset import |
/audit-log · /audit-log/stats · /audit-log/export |
GET | Session | Audit log query, statistics and export; entries and CSV with seq, prevHash and selfHash |
/audit-log/proof |
GET | Session (ADMIN, AUDITOR) | Audit log integrity proof as a ZIP (see "Audit Log: Integrity Proof"); 5 requests/min per organization |
/audit-plans · /audit-plans/:id |
GET, POST · GET, PUT, DELETE | Key/session | Audit plans |
/audit-plans/:id/findings · /audit-plans/:id/findings/:fid |
POST · PUT, DELETE | Key/session | Audit findings |
/audit-tokens · /audit-tokens/:id |
GET, POST · PATCH, DELETE | Session | External auditor tokens; requires permission to invite users (ADMIN) |
/bcm-tests · /bcm-tests/:id |
GET, POST · GET, DELETE | Key/session | Continuity tests |
/branding |
GET | Session | Tenant branding |
/breach-notifications · /:id |
GET, POST · GET, PUT, DELETE | Key | Data breaches (see "Data Breaches"; deadlines run from awareAt ?? detectedAt) |
/business-functions · /:id · /:id/processes |
GET, POST · GET, PUT, DELETE · GET, POST | Key | Business functions and processes (BIA) |
/capa · /capa/:id |
GET, POST · GET, PUT, DELETE | Key/session | Corrective actions |
/compliance-score · /coverage · /gaps · /policies |
GET | Key | Compliance, coverage, gaps and policies (read) |
/gaps/analyze · /knowledge/index |
POST | Key | Gap analysis and knowledge base indexing (AI) |
/contracts · /:id |
GET, POST · GET, PUT, DELETE | Key | Contracts (inherit the vendor's entity) |
/control-exceptions · /:id |
GET, POST · GET, DELETE | Key/session | Control exceptions |
/control-exceptions/:id/approve · /reject |
POST | Session | Approval / rejection, subject to segregation of duties (SoD) |
/controls · /controls/:id/mappings |
GET · GET, POST, DELETE | Key/session | Control catalog and mappings |
/control-tests · /:id |
GET, POST · GET, PATCH, DELETE | Key/session | Control tests (see "Control Tests") |
/customer-satisfaction · /:id |
GET, POST · GET, PUT, DELETE | Key | Customer satisfaction (ISO 9001) |
/dpia · /:id |
GET, POST · GET, PUT, DELETE | Key | Impact assessments (GDPR Art. 35); PUT only edits in DRAFT and does not change the state (see "DPIA") |
/entities |
GET | Session | Entities accessible to the user |
/environmental-aspects · /:id |
GET, POST · GET, PUT, DELETE | Key | Environmental aspects (ISO 14001) |
/evidence · /:id · /:id/ocr |
GET, POST · GET, DELETE · POST | Key/session | Evidence and OCR; POST records UPLOAD or CREATE in the audit log |
/interested-parties · /:id |
GET, POST · GET, PUT, DELETE | Key | Interested parties |
/legal-requirements · /:id |
GET, POST · GET, PUT, DELETE | Key | Legal requirements |
/minutes/import · /minutes/:id/signature-upload |
POST | Session | Minutes import and signature upload |
/monitoring/backup-report |
POST | Key (typical scope: this route) | The backup script reports the status of the targets; requires a configured BACKUP_REPORT integration (409 otherwise); 60 req/min |
/notifications |
GET, PATCH | Session | User notifications |
/organizational-context · /:id |
GET, POST · GET, PUT, DELETE | Key | Organizational context |
/quality-objectives · /:id |
GET, POST · GET, PUT, DELETE | Key | Quality objectives |
/raci · /:id · /:id/assignments · /:id/assignments/:assignmentId |
GET, POST · GET, DELETE · POST · DELETE | Key | RACI matrices |
/regulatory-updates · /:id |
GET, POST · GET, PATCH, DELETE · GET | Key | Regulatory updates |
/reports/executive |
GET | Session | Executive report |
/risks/:id/treatment-actions (+ /:actionId, /suggest) |
GET, POST · PATCH, DELETE · POST | Session | Risk treatment plan |
/ropa |
GET, POST | Session | Record of processing activities (GDPR Art. 30) |
/search |
GET | Session | Global search |
/tasks |
GET, POST | Key | Tasks |
/integrations/slack · /integrations/teams |
GET, POST, DELETE | Session | Slack / Teams notification configuration |
/integrations/wazuh/agents · /integrations/wazuh/alert-rollups |
POST | x-etershield-key + x-tenant-id |
Agent inventory and daily alert aggregates (never raw alerts) |
/wazuh/enroll |
POST | Short-lived enrollment token | Agent enrollment broker; returns the agent key only once; 401 if the token is invalid, expired or used up |
/admin/data-delete |
DELETE | ADMIN session | Deletion of all of the tenant's GRC data (GDPR Art. 17); body { confirm, reason }; irreversible; limited to 1 per day |
/sign/cmd |
POST, PUT | Session | Signing with Chave Móvel Digital |
Coming soonThis page will be available soon.