Skip to content

List configuration change audit events

Request

Returns a paginated list of configuration change audit events for the organization.

The x-total-count response header contains the total number of records matching the query.


Requires audits::read:config permission.

Security
JWTAuthorizer
Query
sTimestring

Start time (ISO 8601) to query from

eTimestring

End time (ISO 8601) to query to

pageinteger

Page number (1-based)

Default:1
limitinteger, <= 10000

Maximum number of results per page (max 10000)

Default:50
sortstring

Sort field and direction, e.g. timestamp:desc

qstring

Free-text search query

auditTypesArray of strings

Filter by audit event types (e.g. create, delete, change, action)

itemTypesArray of strings

Filter by item types (e.g. Node, Cluster)

userNamesArray of strings

Filter by user names

itemIDsArray of strings

Filter by item IDs

ipsArray of strings

Filter by IP addresses

curl -i -X GET \
  'https://apidocs.trustgrid.io/_mock/v2/audit/changes?sTime=string&eTime=string&page=1&limit=50&sort=string&q=string&auditTypes=string&itemTypes=string&userNames=string&itemIDs=string&ips=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Headers
x-total-countinteger

Total number of records matching the query

Bodyapplication/json
Array [
uidstring

Unique identifier

orgstring

Organization ID

timestampstring

Timestamp of the change (ISO 8601)

Example:"2024-10-21T17:35:26Z"
ipstring

IP address of the client that initiated the change

Example:"44.44.44.43"
userNamestring

User who initiated the change

Example:"admin@trustgrid.io"
itemTypestring

Type of the item that was changed

Example:"Node"
itemIdstring

Unique ID of the item that was changed

Example:"19084f81-5668-41ee-adbe-295e4c65531a"
auditTypestring

Type of change event

Enum:"change""create""delete""action"
messagestring

Human-readable description of the change

Example:"Node license created"
]
Response
[ { "uid": "string", "org": "string", "timestamp": "2024-10-21T17:35:26Z", "ip": "44.44.44.43", "userName": "admin@trustgrid.io", "itemType": "Node", "itemId": "19084f81-5668-41ee-adbe-295e4c65531a", "auditType": "change", "message": "Node license created" } ]