For the complete documentation index, see llms.txt. This page is also available as Markdown.

List activity log events

Supports filtering by time range, module, event type and username, plus a free-text search over event descriptions.

get
Authorizations
defguard_sessionstringRequired
Query parameters
pageinteger · int32Optional

Page number. Defaults to 1.

per_pageinteger · int32Optional

Number of items per page, from 1 to 100. Defaults to 50.

fromstringOptional

Start of the reported period as an RFC 3339 timestamp.

untilstringOptional

End of the reported period as an RFC 3339 timestamp.

usernamestringOptional

Filter by username. Admins only.

eventstringOptional

Filter by event type.

modulestringOptional

Filter by module.

searchstringOptional

Free-text search across username, location, module, event type, device, and description.

sort_bystringOptional

Sort key: timestamp, username, location, ip, event, module, or device. Defaults to timestamp.

sort_orderstringOptional

Sort direction: asc or desc. Defaults to desc.

Responses
200

Paginated list of activity log events.

application/json

Envelope returned by paginated endpoints.

get/api/v1/activity_log
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": 1,
      "username": "text"
    }
  ],
  "pagination": {
    "current_page": 1,
    "next_page": null,
    "page_size": 1,
    "total_items": 1,
    "total_pages": 1
  }
}

Last updated

Was this helpful?