Download Reports with CommandShellRecording

The CommandShellRecording query returns the requested command shell recording. Depending on your browser, this query will either immediately begin download or prompt you to open or save the file.

The reporting API is an authenticated API. For instructions on using authenticated APIs using OAuth, see Authenticate to the Remote Support API. The API account must have the permission Allow Access to Support Session Reports and Recordings.

Parameters for CommandShellRecording

lsid=[string] The session ID for which you wish to download the video recording of the command shell.
instance=[integer]

The instance number of the command shell recording you wish to download. Instances are enumerated starting with 0. The instance number can be obtained from the SupportSession report. Unlike the API, the SupportSession report enumerates instances starting at 1. The instance 1 in a SupportSession report should be referenced as instance 0 in the API.

Query Examples for CommandShellRecording

CommandShellRecording:
First shell instance of session c69a8e10bea9428f816cfababe9815fe
  • https://support.example.com/api/reporting?generate_report=CommandShellRecording&lsid=c69a8e10bea9428f816cfababe9815fe&instance=0
CommandShellRecording:
Third shell instance of session c69a8e10bea9428f816cfababe9815fe
  • https://support.example.com/api/reporting?generate_report=CommandShellRecording&lsid=c69a8e10bea9428f816cfababe9815fe&instance=2