The REST API provides the following method to export system logs or audit logs:

POST /api/logs/export

URI POST /api/logs/export
Description Exports system logs or audit logs for the given time range.
Request Header

Accept: application/json 
Content-Type: application/zip
CSRF Protection Enabled
Accept: application/vnd.orchestral.rhapsody.6_5+json 
Content-Type: application/vnd.orchestral.rhapsody.6_5+zip
CSRF Protection Enabled
Request Body

The search parameter data object structure is as follows:

  • logType - [enumerated string] the log type, either AUDIT or SYSTEM.
  • timeRange - [object] defaults to no time restrictions - either a start/end time or a duration can be provided but not both.
    • startTime - [str] date-time in ISO8601 format.
    • endTime - [str] date-time in ISO8601 format.
    • duration - [str] ISO8601 format duration relative to the current date-time.
  • locale - [str] the local to return the logs in.
Response Status 200 OK - returns the configuration in ZIP format.
Response Body A zipped file of pipe-delimited logs. This is the same format as provided by the Management Console export functionality.
Access Rights 'Export logs REST API'.