Rest APIs : REST API : Observer REST : Extracting GigaStor data : Parameters used to extract GigaStor data
Parameters used to extract GigaStor data
Use these options to configure your trace file extraction.
 
Parameter
Description
instanceName
String. The Observer probe instance name from which to extract the GigaStor trace. If you specify a passive instance, the trace is pulled from the passive instance’s parent active instance.
traceFormat
String. The resulting trace file format. Valid options are: pcap, bfr, or pcapng.
traceFileName
String. The resulting trace file name without an extension.
saveTo
String. The location of the resulting trace file. The tempStorage will be available for external download for 24 hours; specifiedPath files are kept indefinitely until you delete them. Valid options are: tempStorage or specifiedPath.
extractionTimeRange
TimeRangeObject. The time range for which to extract the trace.
filter
String, optional. The extraction filter criteria. Any Unicode characters used in the filter are converted to your web browser's character encoding. If a different UTF-level is required, use hexadecimal characters in the filter pattern. See Understanding the filter syntax.
path
String, optional. Required if saveTo parameter is set to specifiedPath. Indicates an absolute folder path to save the resultant trace file to on the Observer hosting the GigaStor such as C:\\myFolder\\traces.
timeStart
String. The start time of the trace file, specified in combined date and time in UTC ISO8601 format.
timeEnd
String. The end time of the trace file, specified in combined date and time in UTC ISO8601 format.