Skip to main content
GET
/
v1
/
regions
/
global
/
audit
List audit events
const options = {method: 'GET'};

fetch('https://api.example.com/v1/regions/global/audit', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "success": true,
  "data": [
    {
      "id": "<string>",
      "timestamp": "2023-11-07T05:31:56Z",
      "actor": {
        "type": "user",
        "id": "<string>",
        "name": "<string>",
        "email": "<string>",
        "ipAddress": "<string>"
      },
      "action": "<string>",
      "resourceType": "<string>",
      "status": "success",
      "severity": "info",
      "category": "<string>",
      "resourceId": "<string>",
      "message": "<string>",
      "changes": {
        "before": {},
        "after": {}
      },
      "metadata": {},
      "organizationId": "<string>",
      "projectId": "<string>"
    }
  ],
  "meta": {
    "total": 123,
    "limit": 123,
    "offset": 123
  }
}

Query Parameters

startDate
string<date-time>

Start date for event search

endDate
string<date-time>

End date for event search

actorId
string

Filter by actor ID

action
string

Filter by action

resourceType
string

Filter by resource type

status
enum<string>

Filter by event status

Available options:
success,
failure,
denied
severity
enum<string>

Filter by severity

Available options:
info,
warning,
error,
critical
category
string

Filter by event category

organizationId
string

Filter by organization ID

projectId
string

Filter by project ID

limit
number
default:50

Maximum number of results to return

offset
number
default:0

Number of results to skip

sortOrder
enum<string>
default:desc

Sort order by timestamp

Available options:
asc,
desc

Response

200 - application/json

List of audit events

success
enum<boolean>
Available options:
true
data
object[]
meta
object