Sign in

v1

latestOpenAPI 3.1.02026-07-22106199311.5 KB
Audit Events

Query audit events in a time range

An endpoint for retrieving audit events in a time range

get/v1/events

Query parameters

fromstring date-time required

The earliest date and time of audit events to retrieve. The date time format should be in ISO 8601 format, e.g.: 2025-02-20T07:15:15.000-01:00

Example:2021-11-17T14:15:15.000Z

The earliest date and time of audit events to retrieve. The date time format should be in ISO 8601 format, e.g.: 2025-02-20T07:15:15.000-01:00

tostring date-time required

The latest date and time of audit events to retrieve. The date time format should be in ISO 8601 format, e.g.: 2025-02-21T07:15:15.000-01:00

Example:2021-11-17T15:15:15.000Z

The latest date and time of audit events to retrieve. The date time format should be in ISO 8601 format, e.g.: 2025-02-21T07:15:15.000-01:00

{"stackTrail":"paths:/v1/events:get:parameters:2:schema","oasType":"schema","type":"unknown"}

Page number (0-indexed)

{"stackTrail":"paths:/v1/events:get:parameters:3:schema","oasType":"schema","type":"unknown"}

Number of records per page (from 1 to 100)

Response

Audit logs have been retrieved

pageinteger

The 0-indexed page number of the returned results.

sizeinteger

The size of each page of results.

totalinteger

Total number of available results across all pages.

Example response

{
  "page": 1,
  "results": [
    {
      "actorEmail": "user123@abc.com",
      "actorId": "123e4567-e89b-12d3-a456-426614174000",
      "eventDescription": "User logged in",
      "eventId": "123e4567-e89b-12d3-a456-426614174000",
      "eventName": "hub_user_login",
      "eventProjectId": "4cfcf46e-5bb1-4887-8772-d1c0eeb0cfef",
      "eventSource": "secrets-reference",
      "eventSubjectId": "C67A9A1A-5A49-4EBF-8222-0C6DCC572505",
      "eventSubjectName": "my-first-secret",
      "eventSubjectType": "USER",
      "eventTimestamp": "2025-01-30T00:30:12.000Z",
      "eventType": "LOGIN"
    }
  ],
  "size": 50,
  "total": 472
}