Skip to content
This repository was archived by the owner on Sep 3, 2021. It is now read-only.

Files

Latest commit

de1ade2 · Jun 5, 2020

History

History
74 lines (46 loc) · 2.74 KB

AuditLogApi.md

File metadata and controls

74 lines (46 loc) · 2.74 KB

AuditLogApi

All URIs are relative to /api/v2

Method HTTP request Description
getAuditLogEntries GET /auditlog Get a list of all audit log entries. The query parameters allow you to restrict the returned results by date ranges, resource specifiers, or a full-text search query.
getAuditLogEntry GET /auditlog/{resourceId} Use this endpoint to fetch a single audit log entry by its resouce ID.

getAuditLogEntries

Get a list of all audit log entries. The query parameters allow you to restrict the returned results by date ranges, resource specifiers, or a full-text search query.

Example

 getAuditLogEntries  before=value  after=value  q=value  limit=value  spec=value

Parameters

Name Type Description Notes
before integer A timestamp filter, expressed as a Unix epoch time in milliseconds. All entries returned will have before this timestamp. [optional]
after integer A timestamp filter, expressed as a Unix epoch time in milliseconds. All entries returned will have occurred after this timestamp. [optional]
q string Text to search for. You can search for the full or partial name of the resource involved or full or partial email address of the member who made the change. [optional]
limit integer A limit on the number of audit log entries to be returned, between 1 and 20. [optional]
spec string A resource specifier, allowing you to filter audit log listings by resource. [optional]

Return type

AuditLogEntries

Authorization

Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getAuditLogEntry

Use this endpoint to fetch a single audit log entry by its resouce ID.

Example

 getAuditLogEntry resourceId=value

Parameters

Name Type Description Notes
resourceId string The resource ID.

Return type

AuditLogEntry

Authorization

Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]