Audit Logs Operations List

Audit Logs Operations List
Search and list audit logs

Search and list audit logs with multi-attribute filtering (Admin, Security Operator and Auditor).

Request
URI
GET
https://{api_host}/api/v1/audit-logs
COPY
Query Parameters
string
q
Optional

Substring search matching actor, action, target name, or details

q example
alice
string
actor
Optional

Filter by actor username

actor example
alice.example
string
action
Optional

Filter by action identifier

action example
PREFERENCE_UPDATE
string
targetType
Optional

Filter by target resource domain. Either one of the Audit Logs Type categories (POLICY, RULE, GROUP, USER, SESSION, HYPERVISOR, ALERT, PREFERENCE, REPORT, SYSTEM), which covers every stored target type of that category (for example USER also covers HYPERVISOR_USER, HYPERVISOR_USER_GROUP and API_TOKEN; SYSTEM also covers SETTING, SSO_SETTINGS, RULE_PACK, DATABASE and SyslogForwarder; REPORT also covers AUDIT_LOG; RULE also covers FILE_CATALOG), or one exact stored target type. AUTH and AUTHENTICATION are accepted as aliases of SESSION and GROUPS of GROUP

targetType example
PREFERENCE
outcome
Optional

Filter by event outcome

outcome example
SUCCESS
string
from
Optional

Start timestamp filter, ISO 8601 date-time with an offset (for example 2026-01-15T09:30:00Z or 2026-01-15T11:30:00+02:00); any offset is accepted

from example
2026-01-15T09:30:00Z
string
to
Optional

End timestamp filter, ISO 8601 date-time with an offset (for example 2026-01-15T09:30:00Z); any offset is accepted

to example
2026-01-16T09:30:00Z
integer
page
Optional
Constraints: minimum: 0 default: 0

Zero-based page index (default: 0)

integer
size
Optional
Constraints: minimum: 1 maximum: 200 default: 20

Number of items per page (default 20, maximum 200). A size above 200 is capped at 200, not rejected. A pageSize above 0 replaces it, see pageSize.

size example
20
integer
pageSize
Optional
Constraints: maximum: 100

Alias of size. When above 0 it replaces size, and a value above 100 is capped at 100; zero or a negative value is ignored and size applies.

pageSize example
20
string
sort
Optional

Sort spec in Spring Data 'property,direction' format (e.g. 'occurredAt,desc'). Sortable properties: occurredAt, actor, actorUsername, actorUserId, actorIp, action, target, targetName, targetType, targetId, outcome, id, auditId. Any other property is rejected with 400 INVALID_SORT.

sort example
occurredAt,desc

Authentication
This operation uses the following authentication methods.
Responses
200

200 OK successful response envelope. A page of audit log summaries, newest first unless sort says otherwise

Returns PaginatedResponse_AuditLogSummaryDto of type(s) application/json
{
    "items": [
        {
            "id": 2,
            "occurredAt": "2026-01-15T09:45:00Z",
            "actorUserId": 2,
            "actorUsername": "bob.example",
            "actorIp": "198.51.100.20",
            "action": "GROUP_PUBLISH",
            "targetType": "SECURITY_GROUP",
            "targetId": "1",
            "targetName": "Production Servers",
            "outcome": "SUCCESS",
            "details": {
                "policyVersion": 4,
                "ruleCount": 20
            }
        },
        {
            "id": 1,
            "occurredAt": "2026-01-15T09:35:00Z",
            "actorUserId": 2,
            "actorUsername": "bob.example",
            "actorIp": "198.51.100.20",
            "action": "POLICY_PUBLISH",
            "targetType": "POLICY",
            "targetId": "2",
            "targetName": "Production Policy",
            "outcome": "SUCCESS",
            "details": {
                "policyVersion": 3,
                "ruleCount": 6,
                "boundGroupCount": 1,
                "changed": true
            }
        }
    ],
    "page": 0,
    "pageSize": 20,
    "totalItems": 2,
    "totalPages": 1
}
array of object
items
Required  

Array of items for the current page

integer As int32 As int32
page
Required  
Constraints: minimum: 0

Zero-based current page number

integer As int32 As int32
pageSize
Required  
Constraints: minimum: 1 maximum: 100

Number of items requested per page

integer As int64 As int64
totalItems
Required  

Total number of items matching filter criteria

integer As int32 As int32
totalPages
Required  
Constraints: minimum: 0

Total number of available pages


400

400 Bad Request: INVALID_ARGUMENT when outcome is not a known outcome, from or to is not an ISO-8601 date-time, or a parameter has the wrong type; INVALID_SORT when sort names a property that cannot be sorted on

Returns ApiErrorResponse of type(s) application/json
{
    "errorCode": "string",
    "message": "string",
    "path": "string",
    "timestamp": "string",
    "reason": "string"
}
errorCode
Required  

Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.

string
message
Required  

Human-readable error description

string
path
Required  

Request URI path that produced the error

string As date-time As date-time
timestamp
Required  

Timestamp when the error occurred as an ISO 8601 date-time with offset

string
reason
Optional

A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.


401

401 Unauthorized: UNAUTHENTICATED when the VTP_SESSION cookie is missing, unknown, expired or revoked

Returns Unauthenticated of type(s) application/json
{
    "errorCode": "string",
    "message": "string",
    "path": "string",
    "timestamp": "string",
    "reason": "string"
}
errorCode
Required  

Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.

string
message
Required  

Human-readable error description

string
path
Required  

Request URI path that produced the error

string As date-time As date-time
timestamp
Required  

Timestamp when the error occurred as an ISO 8601 date-time with offset

string
reason
Optional

A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.


403

403 Forbidden: PASSWORD_CHANGE_REQUIRED when the account must change its password first (only GET /api/v1/auth/session, POST /api/v1/auth/logout and POST /api/v1/auth/change-password are exempt); LICENSE_REQUIRED or LICENSE_EXPIRED while the license pool is restricted (no license, or expired past grace) (exempt: every route under /api/v1/auth, GET /api/v1/user/preferences, GET /api/v1/licensing/summary and POST /api/v1/licensing/licenses)

Returns ApiErrorResponse of type(s) application/json
{
    "errorCode": "string",
    "message": "string",
    "path": "string",
    "timestamp": "string",
    "reason": "string"
}
errorCode
Required  

Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.

string
message
Required  

Human-readable error description

string
path
Required  

Request URI path that produced the error

string As date-time As date-time
timestamp
Required  

Timestamp when the error occurred as an ISO 8601 date-time with offset

string
reason
Optional

A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/v1/audit-logs