---
title: "List audit logs"
method: GET
path: "/logs/audit"
tags: ["Log"]
---

# List audit logs

`GET /logs/audit`

List a page of audit logs.

## Query parameters

- `page` integer
- `limit` integer
- `sortField` 'TIMESTAMP' — All fields used to sort the audit logs
- `sortOrder` 'ASC' | 'DESC' — Sort Order
- `categories` XiqAuditLogCategory[]
- `username` string
- `startTime` integer, required
- `endTime` integer, required
- `keyword` string

## Response `200`

OK

- PagedXiqAuditLog
  - `page` integer, required — The current page number
  - `count` integer, required — The element count of the current page
  - `total_pages` integer, required — The total page number based on request page size
  - `total_count` integer, required — The total element count
  - `data` XiqAuditLog[] — The data in the current page
    - `id` integer, required — The audit log id
    - `category` 'ADMIN' | 'SYSTEM' | 'DEPLOYMENT' | 'CONFIG' | 'MONITOR' | 'ALARM'
    - `user_id` integer — The user id
    - `code` integer — The audit log code
    - `username` string — The user name
    - `vhm_name` string — The vhm name
    - `parameters` string — The audit log parameters
    - `org_id` integer — The org id
    - `timestamp` integer — The audit log timestamp
    - `description` string — The audit log summary
    - `full_description_id` integer — The audit log full description ID

---

[API](https://skmtc.net/extremecloudiq/apis/extremecloud-iq-api.md) · [All operations](https://skmtc.net/extremecloudiq/apis/extremecloud-iq-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/extremecloudiq/extremecloud-iq-api/versions/5ff7ab84e8e8/schema)