Skip to main content

Returns a list of AuditLogs by batches (up to 100 in a single request).

Parameters

Name

In

Type

Required

Description

startDate

query

string(date-time)

false

Filter auditLogs by created or updated after this date (inclusive).

endDate

query

string(date-time)

false

Filter auditLogs by timestamp before this date (exclusive).

size

query

string(int32)

true

AuditLog count to return in one batch min = 1 max = 100.

initiatorId

query

string

false

Identifier of the user or system that initiated the configuration modification (initiatorId). Indicates who performed the action that led to the change.

cursor

query

string

false

An opaque string value that represents a cursor pointer for the next batch of auditLogs.

Detailed descriptions

startDate: Filter auditLogs by created or updated after this date (inclusive). Notes: * The maximum available history duration is determined by your subscription plan. * If the specified date is earlier than the allowed history period for your plan, an error will be returned. * Should use ISO_INSTANT format, e.g. 2022-11-08T14:53:43Z. * Should be less than endDate, otherwise no auditLogs will be returned.

Default value : now - 1 day

endDate: Filter auditLogs by timestamp before this date (exclusive). Notes: * Should use ISO_INSTANT format, e.g. 2022-11-08T14:53:43Z.

initiatorId: Identifier of the user or system that initiated the configuration modification (initiatorId). Indicates who performed the action that led to the change. Notes: * For events from Cloud Connexa Support initiatorId is support@openvpn.com. * For events from Cloud Connexa initiatorId is empty that’s why we can’t find by this field.

Responses

Status

Meaning

Description

Schema

200

OK

OK

AuditLogsResponse

To perform this operation, you must be authenticated by means of one of the following methods: oauth