Audit Logs Operations Get By Id

Audit Logs Operations Get By Id
Get a single audit log event by ID

Retrieve a single audit log event by ID (Admin, Security Operator and Auditor).

Request
URI
GET
https://{api_host}/api/v1/audit-logs/{id}
COPY
Path Parameters
integer
id
Required  

Unique audit event identifier

id example
2

Authentication
This operation uses the following authentication methods.
Responses
200

200 OK successful response envelope. The audit log event

Returns AuditLogSummaryDto of type(s) application/json
{
    "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
    }
}
integer As int64 As int64
id
Required  

Unique audit event identifier

string As date-time As date-time
occurredAt
Required  

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

integer As int64 As int64
actorUserId
Optional

Numeric ID of the initiating user, or null if SYSTEM/unauthenticated

string
actorUsername
Required  

Username of the actor or 'SYSTEM'

string
actorIp
Optional

Origin client IP address in canonical IPv4 or IPv6 format

string
action
Required  

Machine-readable identifier of the audited action, chosen by the code that records the event (for example AGENT_COMMAND_SEND, RULE_CREATE, AUTH_LOGIN); the set is open, and UNKNOWN_ACTION is stored when none was supplied

string
targetType
Optional

Kind of resource the audited action acted on (for example SECURITY_GROUP, POLICY, RULE, HYPERVISOR, AGENT, USER, SESSION), chosen by the code that records the event; the set is open; null when the event has no target

string
targetId
Optional

Unique identifier of the targeted resource

string
targetName
Optional

Human-readable label of the targeted resource

string
outcome
Required  

Result outcome of an audited transaction

  • SUCCESS: The audited operation succeeded; also the value recorded when the caller supplies no outcome
  • FAILURE: The audited operation failed, for example an agent command whose send reported a failure or an alert rule request that raised an exception
Enumeration: SUCCESS, FAILURE
object
details
Optional

Structured metadata or contextual details


400

400 Bad Request: INVALID_ARGUMENT when the id path variable is not a number

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.


404

404 Not Found: AUDIT_LOG_NOT_FOUND when no audit log event has the id

Returns ApiErrorResponse of type(s) application/json
"ApiErrorResponse Object"
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/{id}