List activity log events
Supports filtering by time range, module, event type and username, plus a free-text search over event descriptions.
Page number. Defaults to 1.
Number of items per page, from 1 to 100. Defaults to 50.
Start of the reported period as an RFC 3339 timestamp.
End of the reported period as an RFC 3339 timestamp.
Filter by username. Admins only.
Filter by event type.
Filter by module.
Free-text search across username, location, module, event type, device, and description.
Sort key: timestamp, username, location, ip, event, module, or device. Defaults to timestamp.
Sort direction: asc or desc. Defaults to desc.
Paginated list of activity log events.
Envelope returned by paginated endpoints.
Session is missing or invalid.
Unable to list activity log events.
GET /api/v1/activity_log HTTP/1.1
Accept: */*
{
"data": [
{
"description": null,
"device": "text",
"event": "text",
"id": 1,
"ip": null,
"location": null,
"module": "defguard",
"timestamp": "2026-01-01T00:00:00.000Z",
"user_id": null,
"username": "text"
}
],
"pagination": {
"current_page": 1,
"next_page": null,
"page_size": 1,
"total_items": 1,
"total_pages": 1
}
}Last updated
Was this helpful?