Skip to main content

Audit Log

SDK methods for the Audit Log module, accessed via soat.auditLog. See the Audit Log module docs for permissions and data model, and each method's REST page for the full request/response schema.

soat.auditLog.listAuditEntries()

List audit entries

  • Method: GET
  • Path: /api/v1/audit-log
await soat.auditLog.listAuditEntries({
query: { /* + optional */ },
});

Request & response schema

soat.auditLog.exportAuditEntries()

Export audit entries as NDJSON

  • Method: GET
  • Path: /api/v1/audit-log/export
await soat.auditLog.exportAuditEntries({
query: { project_id, /* + optional */ },
});

Request & response schema

soat.auditLog.getAuditEntry()

Get an audit entry

  • Method: GET
  • Path: /api/v1/audit-log/{entry_id}
await soat.auditLog.getAuditEntry({
path: { entry_id },
});

Request & response schema