POST /_system/auditlogs
Search and retrieve system audit logs (requires view_audit_logs or is_root_user permission)
/_system/auditlogs
POST
Search and retrieve system audit logs (requires view_audit_logs or is_root_user permission)
| Key | Type | Example | Description |
|---|---|---|---|
| authorization required | string |
"Bearer access_token"
|
Access token
|
| Key | Type | Example | Description |
|---|---|---|---|
| query optional | string |
"example-string"
|
Search query string
|
| count optional | boolean |
true
|
Return count instead of results
|
| limit optional | integer |
50
|
Maximum number of results
|
| offset optional | integer |
0
|
Number of results to skip
|
| filters optional | object |
{}
|
Additional search filters
|
| sort optional | array |
[{}]
|
[
{
"_meta": {
"guid": "example-string",
"entity": 42,
"created": 42,
"modified": 42,
"updated": 42
},
"entity": "example-string",
"category": "modified_version",
"action": "core_upgrades",
"data": {},
"user": {
"_meta": {},
"username": "example-string",
"firstname": "example-string",
"lastname": "example-string"
}
}
]
{
"error": "INVALID_ACCESS_TOKEN",
"code": 401
}
| Status | Error Code | Description |
|---|---|---|
401 |
INVALID_ACCESS_TOKEN |
Authentication required or invalid token |
| Permission | Description |
|---|---|
Bearer token |
Access token required via Authorization header, x-authtoken, x-token, query param, or cookie |
auditlogs_create |
Required scope: auditlogs_create |
Back to Audit Logs Return to the Audit Logs category to view other endpoints All API Categories Browse all available API categories