List audit logs for a monitoring configuration of Extension 2.0 in Dynatrace with the Extensions API by extension name, configuration ID, and time range.
| GET | SaaS | https://{your-environment-id}.apps.dynatrace.com/platform/extensions/v2/extensions/{extension-name}/monitoring-configurations/{configuration-id}/audit |
You provide the extension name and configuration ID in the path, and can filter with page-size, page-key, from, to, and sort. Dynatrace returns the audit log entries for that monitoring configuration.
To execute this request, you need a platform token or OAuth access token with extensions:configurations:read scope. To learn how to obtain and use it, see Tokens and authentication.
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| page-size | integer | The amount of extensions in a single response payload. The maximal allowed page size is 100. If not set, 20 is used. | query | Optional |
| page-key | string | The cursor for the next page of results. You can find it in the next-page-key field of the previous response. The first page is always returned if you don't specify the page-key query parameter. When the page-key is set to obtain subsequent pages, you must omit all other query parameters. | query | Optional |
| extension-name | string | The name of the requested Extension 2.0. | path | Required |
| configuration-id | string | The ID of the requested monitoring configuration. | path | Required |
| from | string | The start of the requested timeframe. You can use one of the following formats:
If not set, the relative timeframe of two weeks is used ( | query | Optional |
| to | string | The end of the requested timeframe. You can use one of the following formats:
If not set, the current timestamp is used. | query | Optional |
| sort | string | The sorting of audit log entries:
If not set, the newest first sorting is applied. | query | Required |
| Code | Type | Description |
|---|---|---|
| 200 | Audit | Success. |
| 4XX | Error | Client error. |
| 5XX | Error | Server error. |
AuditLog objectThe audit log of your environment.
| Element | Type | Description |
|---|---|---|
| auditLogs | Audit | A list of audit log entries ordered by the creation timestamp. |
| nextPageKey | string | The cursor for the next page of results. Has the value of Use it in the nextPageKey query parameter to obtain subsequent pages of the result. |
| pageSize | integer | The number of entries per page. |
| totalCount | integer | The total number of entries in the result. |
AuditLogEntry objectAn entry of the audit log.
| Element | Type | Description |
|---|---|---|
| category | string | The category of the recorded operation. The element can hold these values
|
| dt.settings.key | string | The key of the affected object of a setting for entries of category |
| dt.settings.object_id | string | The ID of the affected object of a setting for entries of category |
| dt.settings.object_summary | string | The value summary for entries of category |
| dt.settings.schema_id | string | The schema ID or config ID for entries of category |
| dt.settings.scope_id | string | The persistence scope for entries of category |
| dt.settings.scope_name | string | The display name of the scope for entries of category |
| 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.
The element can hold these values
|
| logId | string | The ID of the log entry. |
| message | string | The logged message. |
| patch | Any | 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.
The element can hold these values
|
AnyValue objectA schema representing an arbitrary value type.
ErrorEnvelope object| Element | Type | Description |
|---|---|---|
| error | Error | - |
Error object| Element | Type | Description |
|---|---|---|
| code | integer | The HTTP status code. |
| details | Error | The error details. |
| message | string | The error message. |
ErrorDetails objectThe error details.
| Element | Type | Description |
|---|---|---|
| constraintViolations | Constraint | A list of constraint violations. |
ConstraintViolation objectA list of constraint violations.
| Element | Type | Description |
|---|---|---|
| location | string | - |
| message | string | - |
| parameterLocation | string | -The element can hold these values
|
| path | string | - |
{"auditLogs": [{"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"}],"nextPageKey": "___a7acX3q0AAAAAACJidWlsdGluOnNlcnZpY2lUVEJCUzBaNVIxVjJOSGt6Y3oyLTcwMUZWRkxlclH__9rtpxferQ","pageSize": 5,"totalCount": 10}
{"error": {"code": 1,"details": {"constraintViolations": [{"location": "string","message": "string","parameterLocation": "HEADER","path": "string"}]},"message": "string"}}