Audit logs API - GET audit log entry
Fetches the specified entry of the audit log.
GET | ManagedDynatrace for Government | https://{your-domain}/e/{your-environment-id}/api/v2/auditlogs/{id} |
SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/auditlogs/{id} | |
Environment ActiveGate | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/auditlogs/{id} |
Authentication
To execute this request, you need an access token with auditLogs.read
scope.
To learn how to obtain and use it, see Tokens and authentication.
Parameters
Parameter | Type | Description | In | Required |
---|---|---|---|---|
id | string | The ID of the required log entry. | path | required |
Response
Response codes
Code | Type | Description |
---|---|---|
200 | Audit | Success |
400 | ErrorEnvelope | Failed. Invalid ID format. |
404 | ErrorEnvelope | Failed. The requested resource doesn't exist. |
Response body objects
The AuditLogEntry
object
An entry of the audit log.
Element | Type | Description |
---|---|---|
category | string | The category of the recorded operation. |
entityId | string | The ID of an entity from the category. For example, it can be config ID for the |
environmentId | string | The ID of the Dynatrace environment where the recorded operation occurred. |
eventType | string | The type of the recorded operation. |
logId | string | The ID of the log entry. |
message | string | The logged message. |
patch | object | The patch of the recorded operation as the JSON representation. The format is an enhanced RFC 6902. The patch also carries the previous value in the oldValue field. |
success | boolean | The recorded operation is successful ( |
timestamp | integer | The timestamp of the record creation, in UTC milliseconds. |
user | string | The ID of the user who performed the recorded operation. |
userOrigin | string | The origin and the IP address of the user. |
userType | string | The type of the authentication of the user. |
Response body JSON model
{
"category": "CONFIG",
"entityId": "MOBILE_RUM: MOBILE_APPLICATION-752C223D59734CD2",
"environmentId": "prod-env-13",
"eventType": "UPDATE",
"logId": "197425568800060000",
"patch": [
{
"oldValue": 20000,
"op": "replace",
"path": "/refreshTimeIntervalMillis",
"value": 30000
}
],
"success": true,
"timestamp": 1974255688445,
"user": "test.user@company.com",
"userOrigin": "webui (192.168.0.2)",
"userType": "USER_NAME"
}
Example
In this example, the request gets the audit log entry with the ID of 157607396300050000.
This entry stores information about a change to the configuration of the dashboard with the ID of 14b3bfe7-69d8-48bf-b08a-4f9a2ff3f703. The change is a repositioning and resizing of a tile done by the Dynatrace user with user ID 643541629.
The API token is passed in the Authorization header.
Curl
curl -X GET \
'https://mySampleEnv.live.dynatrace.com/api/v2/auditlogs/157607396300050000' \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'
Request URL
https://mySampleEnv.live.dynatrace.com/api/v2/auditlogs/157607396300050000
Response body
{
"logId": "157607396300050000",
"eventType": "UPDATE",
"category": "CONFIG",
"entityId": "DASHBOARDS_SETTINGS: 14b3bfe7-69d8-48bf-b08a-4f9a2ff3f703",
"environmentId": "yasmuoujsw",
"user": "Dynatrace user #643541629",
"userType": "USER_NAME",
"userOrigin": "webui (240.204.62.255)",
"timestamp": 1576074315483,
"success": true,
"patch": [
{
"op": "replace",
"path": "/tiles/24/top",
"value": 304,
"oldValue": 380
},
{
"op": "replace",
"path": "/tiles/24/left",
"value": 304,
"oldValue": 798
},
{
"op": "replace",
"path": "/tiles/24/width",
"value": 608,
"oldValue": 304
},
{
"op": "replace",
"path": "/tiles/24/height",
"value": 608,
"oldValue": 304
}
]
}
Response code
200