Skip to content

Upload a trace using the API Client🔗

Before uploading a trace, make sure you have:

Upload a Trace🔗

Perform trace upload using the cs-api upload-trace command in the API Client.

Tip

Use cs-api upload-trace --help to get detailed information about the command-line options specific to the upload-trace command.

Upload size limitations🔗

When uploading PCAP files, consider the available memory on the analysis VM. For optimal performance, the recommended file size is within half of the server’s RAM. For example, on a 16-gigabyte RAM server, limit uploads to files not exceeding 8 gigabytes.

Caution

Exceeding the prescribed file size limit for PCAP uploads may result in server instability. It is strongly recommended to stay within the designated file size limit to maintain server stability and application performance.

Example🔗

Use the following example as a guide for uploading a trace using the API client.

Bash
$ export CRYPTOSENSE_API_KEY=secret
$ ./cs-api upload-trace \
    --project-name 1 \
    --slot-name 'Slot Name' \
    --trace-name 'Test trace' \
    --trace-file test_trace.cst.gz
Request: POST https://analyzer.cryptosense.com/api/v1/trace_s3_post
Request: POST https://analyzer.cryptosense.com/api/v1/trace_s3_post
Request: POST https://analyzer.cryptosense.com/storage-traces
[=====================================================================================] 100.00%
Request: POST https://analyzer.cryptosense.com/api/v1/projects/1/traces
Trace imported

Find project information🔗

For existing projects, you’ll find the information you need in the AQtive Guard Web Interface:

  1. In the web interface, select Projects from the menu bar.
  2. Select the desired project name to open the project Overview, then select the Reports tab.
  3. The Reports table displays information for all the reports in the selected project, including the:
    • project-name at the top of the table
    • slot-name used for existing slots
    • trace-file used for the analysis

Tip

You can use the --slot-name ... command-line option to select the slot where you will upload the trace. If no slot exists with the name you enter, a new slot with this name will be created.