Skip to content

List an organization's audit log

GET
/api/organizations/{organizationId}/audit-logs

Returns the append-only audit trail for the given organization, newest first. Each entry records who changed what and when. The trail is read-only: entries are written automatically whenever audited resources change and cannot be created, edited, or deleted through the API. Paginated at 30 entries per page (max 50) and filterable by entity type and id, acting user, action, zone, IP address, and by partial match on the entity label or user display name.

Authorizations

ApiToken

Long-lived API token created via POST /api/api-tokens (returned once in plaintext).

Type
API Key (header: X-API-TOKEN)
or
JWT

JWT access token obtained via POST /api/auth/login. Send as: Authorization: Bearer .

Type
HTTP (bearer)

Parameters

Path Parameters

organizationId*

Organization identifier

Type
string
Required

Query Parameters

page

The collection page number

Type
integer
Default
1
itemsPerPage

The number of items per page

Type
integer
Default
30
Minimum
0
Maximum
50
exists[userId]
Type
boolean
createdAt[before]
Type
string
createdAt[strictly_before]
Type
string
createdAt[after]
Type
string
createdAt[strictly_after]
Type
string
entityType

Filter by the audited entity type (kebab-case), e.g. zone, access-rule, basic-auth-user, certificate.

Type
string
entityType[]

Filter by the audited entity type (kebab-case), e.g. zone, access-rule, basic-auth-user, certificate.

Type
array
entityId

Filter by the audited entity's identifier as a string (a UUID for UUID-keyed entities, otherwise the numeric id).

Type
string
entityId[]

Filter by the audited entity's identifier as a string (a UUID for UUID-keyed entities, otherwise the numeric id).

Type
array
userId

Filter by the UUID of the user who performed the action.

Type
string
Format
"uuid"
userId[]

Filter by the UUID of the user who performed the action.

Type
array
action

Filter by action type. One of create, update, delete.

Type
string
action[]

Filter by action type. One of create, update, delete.

Type
array
zoneId

Filter by the denormalised zone id the change occurred in (only set for zone-scoped entities).

Type
string
zoneId[]

Filter by the denormalised zone id the change occurred in (only set for zone-scoped entities).

Type
array
ipAddress

Filter by the client IP address recorded for the change.

Type
string
ipAddress[]

Filter by the client IP address recorded for the change.

Type
array
entityLabel

Partial (substring) match on the entity's human-readable label.

Type
string
entityLabel[]

Partial (substring) match on the entity's human-readable label.

Type
array
userDisplayName

Partial (substring) match on the acting user's display name.

Type
string
userDisplayName[]

Partial (substring) match on the acting user's display name.

Type
array
order[createdAt]

Sort by creation time. Accepts asc or desc (defaults to newest first).

Type
string
Valid values
"asc""desc""ASC""DESC"

Responses

audit-log collection

JSON
{
  
"totalItems": 0,
  
"search": {
  
  
"@type": "string",
  
  
"template": "string",
  
  
"variableRepresentation": "string",
  
  
"mapping": [
  
  
  
{
  
  
  
  
"@type": "string",
  
  
  
  
"variable": "string",
  
  
  
  
"property": "string",
  
  
  
  
"required": true
  
  
  
}
  
  
]
  
},
  
"view": {
  
  
"@id": "string",
  
  
"@type": "string",
  
  
"first": "string",
  
  
"last": "string",
  
  
"previous": "string",
  
  
"next": "string"
  
},
  
"member": [
  
  
{
  
  
  
"@context": "string",
  
  
  
"@id": "string",
  
  
  
"@type": "string",
  
  
  
"id": "0193b6c2-8f1a-7c3d-9e2b-1a2b3c4d5e6f",
  
  
  
"userId": "0192f8a1-4b2c-7d3e-8f10-abcdef012345",
  
  
  
"userEmail": "jane@example.com",
  
  
  
"userDisplayName": "Jane Doe",
  
  
  
"action": "update",
  
  
  
"zoneId": 42,
  
  
  
"entityType": "zone",
  
  
  
"entityId": "128",
  
  
  
"entityLabel": "shop.example.com",
  
  
  
"changes": {
  
  
  
  
"additionalProperties": "string"
  
  
  
},
  
  
  
"ipAddress": "203.0.113.7",
  
  
  
"createdAt": "2026-01-16T12:00:00.123456+00:00"
  
  
}
  
]
}

Playground

Authorization
Variables
Key
Value

Samples

Powered by VitePress OpenAPI