Get Audit Logs

POST 
/audit/api/v1/log

Retrieves paginated audit logs based on the provided filter criteria.

Rate Limits

The following rate limits apply:

• Request rate limit: 10/sec
• Burst limit: 10/sec

Request

application/json

Body

required

timeRange objectrequired

The time range for the audit log filter

type stringrequired

Possible values: [relative, absolute, to_now]

Time Type

value object required

Time Range Value

oneOf

RelativeTimeRangeValue

amount int32required

Time Amount for 'relative' Time Range

unit stringrequired

Possible values: [minute, hour, day, week, month, year]

Time Unit for 'relative' Time Range. 'login' not supported here

AbsoluteTimeRangeValue

startTime int64required

Start Time for 'absolute' Time Range

endTime int64

End Time for 'absolute' Time Range

ToNowTimeRangeValue

string

Possible values: [login]

filters object[]
List of audit log filters
Array [
name string
value string
]
limit int32

Default value: 500

The maximum number of results to return per page. Valid Range: [100, 500]

nextPageToken string

The optional token to retrieve the next page of results

Responses

200

Successful Operation

application/json

Schema

Schema

value object[]
The list of audit logs that match the request
Array [
timestamp int64
The time stamp of the log entry
action string
ipAddress string
The IP address of associated with the performed the action
actionType string
Possible values: [CREATE, READ, UPDATE, DELETE, LOGIN]
Represents the type of action performed on a resource by a given user or system
resourceName string
The name of the resource associated with the action
resourceType string
The type of the resource associated with the action
result string
The result of the action performed
user string
The user associated with the action
]
nextPageToken string

The token to use to retrieve the next page of results

Example (from schema)

{
  "value": [
    {
      "timestamp": 1623733133000,
      "action": "User foo@boo.com logged in via password",
      "ipAddress": "127.0.0.1",
      "actionType": "LOGIN",
      "resourceName": "foo@boo.com",
      "resourceType": "Login",
      "result": "Success",
      "user": "foo@boo.com"
    }
  ],
  "nextPageToken": "string"
}

400

Bad Request

application/json

Schema

Schema

error object

The actual error object

code stringrequired

Error Codes: BadRequest(400), Unauthorized(401), Forbidden(403), TooManyRequests(429).

message stringrequired

A human-readable representation of the error.

target string

The target of the error

details undefined[]

An array of details about specific errors that led to this reported error

Example (from schema)

{
  "error": {
    "code": "string",
    "message": "string",
    "target": "string",
    "details": [
      null
    ]
  }
}

401

Unauthorized

application/json

Schema

Schema

error object

The actual error object

code stringrequired

Error Codes: BadRequest(400), Unauthorized(401), Forbidden(403), TooManyRequests(429).

message stringrequired

A human-readable representation of the error.

target string

The target of the error

details undefined[]

An array of details about specific errors that led to this reported error

Example (from schema)

{
  "error": {
    "code": "string",
    "message": "string",
    "target": "string",
    "details": [
      null
    ]
  }
}

403

Forbidden

application/json

Schema

Schema

error object

The actual error object

code stringrequired

Error Codes: BadRequest(400), Unauthorized(401), Forbidden(403), TooManyRequests(429).

message stringrequired

A human-readable representation of the error.

target string

The target of the error

details undefined[]

An array of details about specific errors that led to this reported error

Example (from schema)

{
  "error": {
    "code": "string",
    "message": "string",
    "target": "string",
    "details": [
      null
    ]
  }
}

429

Too Many Requests

application/json

Schema

Schema

error object

The actual error object

code stringrequired

Error Codes: BadRequest(400), Unauthorized(401), Forbidden(403), TooManyRequests(429).

message stringrequired

A human-readable representation of the error.

target string

The target of the error

details undefined[]

An array of details about specific errors that led to this reported error

Example (from schema)

{
  "error": {
    "code": "string",
    "message": "string",
    "target": "string",
    "details": [
      null
    ]
  }
}

Loading...