diff --git a/docs/img/compliance_download.png b/docs/img/compliance_download.png new file mode 100644 index 0000000000..32aed141b3 Binary files /dev/null and b/docs/img/compliance_download.png differ diff --git a/docs/img/compliance_section.png b/docs/img/compliance_section.png new file mode 100644 index 0000000000..2b64031550 Binary files /dev/null and b/docs/img/compliance_section.png differ diff --git a/docs/img/download_output.png b/docs/img/download_output.png index 0ea2f73f72..452851b84d 100644 Binary files a/docs/img/download_output.png and b/docs/img/download_output.png differ diff --git a/docs/img/output_folder.png b/docs/img/output_folder.png index 1806924ec7..11ae4d9925 100644 Binary files a/docs/img/output_folder.png and b/docs/img/output_folder.png differ diff --git a/docs/img/scan_jobs_section.png b/docs/img/scan_jobs_section.png new file mode 100644 index 0000000000..e307cf7f60 Binary files /dev/null and b/docs/img/scan_jobs_section.png differ diff --git a/docs/tutorials/prowler-app.md b/docs/tutorials/prowler-app.md index f63556f758..0137689147 100644 --- a/docs/tutorials/prowler-app.md +++ b/docs/tutorials/prowler-app.md @@ -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. +Scan Jobs section + +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. Download output -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--`, 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. Output folder ???+ 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. + +Compliance section + +- Find the Framework report you need. + +- Click its **Download** icon to retrieve that report’s CSV file with all the detailed findings. + +Download compliance output + +???+ 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)