Audit

Overview

Our Audit service provides the APIs needed to retrieve log activity. These logs may be filtered using the Audit object’s parameters. The Audit Logs routes support pagination.

The audit object

{
    "identifier": "...",
    "sourceRepository": "...",
    "eventType": "...",
    "eventResourceIdentifier": "...",
    "jobLifeCycleIdentifier": "...",
    "eventDetail": {},
    "key": "...",
    "internal": false,
    "createdAt": "..."
}

Parameter

Type

Description

identifier

string

Record identifier of an event or instance of the API’s workflow.

sourceRepository

string

A set of repositories from where the results are retrieved.

eventType

string

Reference to the type of action performed in the instance that is being recorded.

eventResourceIdentifier

string

Reference to the API’s resource used during the instance that is being recorded.

jobLifeCycleIdentifier

string

The job’s identifier. It groups all of the audit identifiers related to a single job execution.

eventDetail

object

The body of the original request being audited.

key

string

A set of API key prefixes. Resulting records are filtered with the API key prefixes provided.

internal

boolean

Allows users to select to audit internal or external endpoints. Default is false which returns both.

createdAt

string

The time that the instance occurred.