AuditLogResource
The following resources are part of this group:
/auditLog
GET
Retrieve the audit logs based on URI parameter criteria.
Parameters
| name | description | type | default |
|---|---|---|---|
| limit | Max result size. Required. | query | |
| offset | The offset from the first result. Default 0. | query | |
| fromDate | The from date in RFC2822 string. | query | |
| endDate | The end date in RFC2822 string. | query | |
| duration | The time duration in hours. | query | |
| userName | The "name/part of name" of the user who modified the object. | query | |
| remoteAddress | The IP address of the remote client that sent the request | query | |
| objectType | The type of the object modified. | query | |
| objectName | The name/part of name of the object modified. | query | |
| objectIdentifier | the object identifier | query | |
| operationType | The type of the operation. | query | |
| description | The description/part of description of the audit operation. | query | |
| configurationId | a list of cluster node configuration id-s. | query | |
| fields | comma separated string of audit log properties to return | query | |
| version | (no documentation provided) | path |
Response Body
| element: | auditLogEntries |
representation of the audit log entries
/auditLog/count
GET
Gets the number of audit log entries found on the specified criteria.
Parameters
| name | description | type | default |
|---|---|---|---|
| fromDate | The from date in RFC2822 string. | query | |
| endDate | The end date in RFC2822 string. | query | |
| duration | The time duration in hours. | query | |
| userName | The "name/part of name" of the user who modified the object. | query | |
| remoteAddress | The IP address of the remote client that sent the request. | query | |
| objectType | The type of the object modified. | query | |
| objectName | The name/part of name of the object modified. | query | |
| objectIdentifier | the object identifier | query | |
| operationType | The type of the operation. | query | |
| description | The description/part of description of the audit operation | query | |
| configurationId | a list of cluster node configuration id-s. | query | |
| version | (no documentation provided) | path |
Response Body
| element: | collectionCount |
the count of audit log entries
/auditLog/export
GET
Exports the audit log in a CSV format based on the specified criteria.
Parameters
| name | description | type | default |
|---|---|---|---|
| fromDate | The from date in RFC2822 string. | query | |
| endDate | The end date in RFC2822 string. | query | |
| duration | The time duration in hours. | query | |
| userName | The "name/part of name" of the user who modified the object. | query | |
| remoteAddress | The IP address of the remote client that sent the request | query | |
| objectType | The type of the object modified. | query | |
| objectName | The name/part of name of the object modified. | query | |
| objectIdentifier | the object identifier | query | |
| operationType | The type of the operation. | query | |
| description | The description/part of description of the audit operation. | query | |
| configurationId | a list of cluster node configuration id-s. | query | |
| version | (no documentation provided) | path |
Response Body
| element: | (custom) |
the audit logs
/auditLog/objectTypes
GET
Gets types of the audited objects.
Parameters
| name | description | type | default |
|---|---|---|---|
| version | (no documentation provided) | path |
Response Body
| element: | auditedObjectTypes |
AuditedObjectTypes
/auditLog/{auditLogId}
GET
Gets a single audit log entry.
Parameters
| name | description | type | default |
|---|---|---|---|
| auditLogId | the audit log entry id. | path | |
| version | (no documentation provided) | path |
Response Body
| element: | auditLogEntry |
the representation of the audit log entry.
POST
Updates an audit log entry description.
Parameters
| name | description | type | default |
|---|---|---|---|
| auditLogId | the audit log entry id. | path | |
| version | (no documentation provided) | path |
Request Body
| element: | auditLogEntry |
the audit log entry containing new description.