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. Note that the requesting user must have permission to view session recordings.

The reporting API is an authenticated API. For instructions on using authenticated APIs using OAuth, see Authenticate to the PA API. The API account used to call this report must have access to the reporting API.

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 AccessSession report.

Optional Parameter for CommandShellRecording

format=[string] If this parameter has the value of txt, the command shell output will be in a text format instead of a recording.

Query Examples for CommandShellRecording

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