Query audit logs

Query and aggregate audit logs. Admin role with auditView privilege required.

GET /v1/admin/audit-logs

Query audit logs

cURL

curl --request GET \
  --url http://co-mind-platform-host/v1/admin/audit-logs \
  --header 'Authorization: Bearer <token>'

200

{
  "data": [
    {
      "id": "<string>",
      "timestamp": "2023-11-07T05:31:56Z",
      "category": "<string>",
      "action": "<string>",
      "severity": "<string>",
      "userId": "<string>",
      "details": {}
    }
  ],
  "total": 123,
  "limit": 123,
  "offset": 123
}

Authorizations

Authorization · string · header · required

Bearer token authentication. Supports two token types:

• JWT Access Token — obtained via POST /v1/auth/login
• Personal Access Token (PAT) — created via POST /v1/api-tokens, format: cmnd_<tokenId>.<secret>

Query Parameters

limit · integer · default: 50

Maximum number of records to return

offset · integer · default: 0

Offset for pagination

category · string

Filter by event category

action · string

Filter by action type

severity · string

Filter by severity level

startDate · string<date-time>

Start date filter

endDate · string<date-time>

End date filter

userId · string

Filter by user ID

aggregateBy · string

Field to aggregate results by

Response

200

application/json

Audit log results

data · object[]

Show child attributes

total · integer

limit · integer

offset · integer