Skip to main content

Audit log

These endpoints need a Keycloak access token with the admin platform role. On a multi-organization install, an organization admin can read their own organization's events. See Audit log for what is recorded.

Read events​

GET/audit-log

Events, newest first.

Query parameters​

actionstringoptional
Only this action, such as chat or approve_tool_call.
actorstringoptional
Only events by this actor, a Keycloak user ID or system.
tenant_idstringoptional
Only events for this project or tenant.
decisionstringoptional
allow or deny.
sincestringoptional
Only events at or after this time, in ISO 8601.
untilstringoptional
Only events at or before this time, in ISO 8601.
limitintegeroptional
Up to 1,000. Default 100.
offsetintegeroptional
How many matching events to skip. Default 0.

Response fields​

events[].sequenceintegeroptional
The event's place in the chain.
events[].actorstringoptional
Who did it.
events[].actionstringoptional
What was done.
events[].resourceobjectoptional
What it was done to.
events[].decisionstring or nulloptional
allow, deny or null.
events[].metadataobject or nulloptional
Extra detail.
events[].tenant_idstring or nulloptional
The project the event belongs to. Model calls carry no project and show unknown.
events[].created_atstringoptional
When it was written.
events[].prev_hashstringoptional
The previous event's hash.
events[].event_hashstringoptional
This event's hash.

Responses​

200
The events.
403
Not a platform admin.
502
The audit service could not be reached.

Verify the chain​

GET/audit-log/verify

Recomputes every event's hash from the start of the chain.

Response fields​

validbooleanoptional
true if every event and every link is intact.
broken_at_sequenceinteger or nulloptional
The first event where the chain breaks.
checkedintegeroptional
How many events were checked.

Checkpoints, SIEM export and retention​

All platform admin. Every change made here is itself an audit event, with secrets reduced to "set" or "not set". See Audit log.

Method and pathWhat it does
GET /audit-log/checkpointsThe newest signed checkpoints, up to limit (default 20, at most 500).
POST /audit-log/checkpointsSign the chain head now.
GET /audit-log/keysThe key ids and Ed25519 public keys, for verifying exported checkpoints elsewhere.
GET /audit-log/exportThe SIEM sinks and each one's progress.
PUT /audit-log/export/sinks{"sinks": [...]}: replace the sinks managed in the console. Each sink has an id, name, type (syslog, webhook, splunk_hec or s3), enabled and its type's settings.
POST /audit-log/export/sinks/{sink_id}/testSend a test event to a sink.
GET /audit-log/retentionThe retention in force, and its minimum.
PUT /audit-log/retention{"days": 730}. 0 keeps events forever. Never below the minimum.
Was this page helpful?
On this page
Talk to our teamQuestions about licensing or sizing VoisX Orchestrate for your site? We can help.Talk to sales →