latestOpenAPI 3.0.3GitGuardian2026-08-201871515.0 MB

511b067cdcb1

Audit Logs

List audit Logs

List audit logs.

get/v1/audit_logs

Query parameters

cursorstring

Pagination cursor.

per_pageinteger

Number of items to list per page.

date_beforestring datetime

Entries found before this date.

Example:2019-08-30T14:15:22Z
date_afterstring datetime

Entries found after this date.

Example:2019-08-22T14:15:22Z
event_namestring
Example:user.logged_in

Entries matching this event name.

member_idinteger
Example:3252

The id of the member to retrieve.

member_namestring
Example:John Smith

Entries matching this member name.

member_emailstring
Example:john.smith@example.org

Entries matching this member email.

api_token_idstring uuid
Example:fdf075f9-1662-4cf1-9171-af50568158a8

Entries matching this API token id.

ip_addressstring
Example:8.8.8.8

Entries matching this IP address.

Response

Audit logs List

idinteger
datestring date-time
member_emailstring nullable
member_namestring nullable

Name of the member at the time he/she did the event. It may differ from the current name of the member if it has been updated since.

member_idinteger nullable

ID of the member that did the event. Can be null if the member has been deleted since then: in that case use member_name and member_email to identify the author of the action.

api_token_idstring uuid nullable

ID of the API token associated to the event if it was done via the API. Can be null if the action was not performed via the API.

ip_addressstring nullable
target_idsstring[]
action_type'READ' | 'CREATE' | 'UPDATE' | 'DELETE' | 'OTHER'
event_namestring
dataobject nullable

Additional data associated to the event.

Example response

[
  {
    "id": 3759,
    "date": "2019-08-22T14:15:22Z",
    "member_email": "eric@gitguardian.com",
    "member_name": "Eric",
    "member_id": 1243,
    "api_token_id": "41f016f9-d44b-451c-a816-df041c057c6b",
    "target_ids": [
      "1243",
      "2bb559aa-bd72-48ca-b4ba-bf09b1c9a658"
    ],
    "action_type": "READ",
    "event_name": "user.logged_in"
  }
]