Session Audits API

Retrieves all audit messages for a specified session from the controller, broker, and target. It requires the session ID path parameter and returns 200 for success with structured audit entries, or 400 if the session is not found and 500 for server errors.

Table 1. GET /ondemand/api/sessions/{id}/audits
Property Description
Summary Fetch Session Audit Messages.
Description Retrieves all audit logs from the controller, broker, and target for a specific session.
Path Parameters
id (String, Required)
The unique identifier of the session.
Responses
  • 200 OK: Successfully retrieved audit messages. For example - 
    {
  "sessionID": "2345",
  "auditMessages": {
    "controller": [
      {
        "timeStamp": "2026-02-23T10:00:01Z",
        "auditMessage": "Controller initialized session."
      },
      {
        "timeStamp": "2026-02-23T10:05:30Z",
        "auditMessage": "Controller connected to target."
      }
    ],
    "broker": [
      {
        "timeStamp": "2026-02-23T10:00:02Z",
        "auditMessage": "Broker accepted session request."
      }
    ],
    "target": [
      {
        "timeStamp": "2026-02-23T10:00:03Z",
        "auditMessage": "Target accepted incoming connection."
      }
    ]
  }
}
  • 400 Not Found: Session ID does not exist.
  • 500 Internal Server Error: Error retrieving audit logs.