docs: update the download export documentation (#7682)
BIN
docs/img/compliance_download.png
Normal file
|
After Width: | Height: | Size: 65 KiB |
BIN
docs/img/compliance_section.png
Normal file
|
After Width: | Height: | Size: 9.0 KiB |
|
Before Width: | Height: | Size: 153 KiB After Width: | Height: | Size: 39 KiB |
|
Before Width: | Height: | Size: 27 KiB After Width: | Height: | Size: 54 KiB |
BIN
docs/img/scan_jobs_section.png
Normal file
|
After Width: | Height: | Size: 16 KiB |
@@ -194,15 +194,45 @@ To view all `new` findings that have not been seen prior to this scan, click the
|
||||
|
||||
## **Step 9: Download the Outputs**
|
||||
|
||||
Once the scan is complete, you can download the output files generated by Prowler as a single `zip` file. This archive contains the CSV, JSON-OSCF, and HTML reports detailing the findings.
|
||||
Once a scan is complete, navigate to the Scan Jobs section to download the output files generated by Prowler:
|
||||
|
||||
To download these files, click the **Download** button. This button becomes available only after the scan has finished.
|
||||
<img src="../../img/scan_jobs_section.png" alt="Scan Jobs section" width="700"/>
|
||||
|
||||
These outputs are bundled into a single .zip archive containing:
|
||||
|
||||
- CSV report
|
||||
|
||||
- JSON-OSCF formatted results
|
||||
|
||||
- HTML report
|
||||
|
||||
- A folder with individual compliance reports
|
||||
|
||||
???+ note "Note"
|
||||
The Download button only becomes active after a scan completes successfully.
|
||||
|
||||
<img src="../../img/download_output.png" alt="Download output" width="700"/>
|
||||
|
||||
This action downloads a `zip` file containing an `output` folder, which includes the files mentioned above: CSV, JSON-OSCF, and HTML reports.
|
||||
The `zip` file unpacks into a folder named like `prowler-output-<provider_id>-<timestamp>`, which includes all of the above outputs. In the example below, you can see the `.csv`, .`json`, and `.html` reports alongside a subfolder for detailed compliance checks.
|
||||
|
||||
<img src="../../img/output_folder.png" alt="Output folder" width="700"/>
|
||||
|
||||
???+ note "API Note"
|
||||
To learn more about the API endpoint the UI uses to download ZIP exports, see: [Prowler API Reference - Download Scan Output](https://api.prowler.com/api/v1/docs#tag/Scan/operation/scans_report_retrieve)
|
||||
For more information about the API endpoint used by the UI to download the ZIP archive, refer to: [Prowler API Reference - Download Scan Output](https://api.prowler.com/api/v1/docs#tag/Scan/operation/scans_report_retrieve)
|
||||
|
||||
## **Step 10: Download specified compliance report**
|
||||
|
||||
Once your scan has finished, you don’t need to grab the entire ZIP—just pull down the specific compliance report you want:
|
||||
|
||||
- Navigate to the **Compliance** section of the UI.
|
||||
|
||||
<img src="../../img/compliance_section.png" alt="Compliance section" width="700"/>
|
||||
|
||||
- Find the Framework report you need.
|
||||
|
||||
- Click its **Download** icon to retrieve that report’s CSV file with all the detailed findings.
|
||||
|
||||
<img src="../../img/compliance_download.png" alt="Download compliance output" width="700"/>
|
||||
|
||||
???+ note "API Note"
|
||||
To fetch a single compliance report via API, see the Retrieve compliance report as CSV endpoint in the Prowler API Reference.[Prowler API Reference - Retrieve compliance report as CSV](https://api.prowler.com/api/v1/docs#tag/Scan/operation/scans_compliance_retrieve)
|
||||
|
||||