Prowler Cloud

Prowler Cloud is a web application that simplifies running Prowler. This tutorial will guide you through setting up and using it. We refer to Prowler App as the self-hosted version of Prowler Cloud.

​

Accessing Prowler Cloud and API Documentation

If you are a Prowler Cloud user, you can access API docs at https://api.prowler.com/api/v1/docs

​

Step 1: Sign Up

​

Sign Up with Email

To get started, sign up using your email and password:

​

Sign Up with Social Login

If Social Login is enabled, you can sign up using your preferred provider (e.g., Google, GitHub).

​

Step 2: Log In

Once registered, log in with your email and password to access Prowler App. Upon logging in, the Overview page will display. At this stage, no data is present: add a provider to begin scanning your cloud environment.

​

Step 3: Add a Provider

To perform security scans, link a cloud provider account. Prowler supports the following providers and more:

• AWS
• Azure
• Google Cloud Platform (GCP)
• Kubernetes
• M365
• GitHub

Steps to add a provider:

1. Navigate to Settings > Cloud Providers.
2. Click Add Account to set up a new provider and provide your credentials.

​

Step 4: Configure the Provider

Select the cloud provider to scan and configure authentication credentials. Each provider has specific requirements and authentication methods. For detailed instructions on configuring credentials for each provider, refer to the provider-specific getting started guides:

​

Step 5: Test Connection

After adding your credentials of your cloud account, click the Launch button to verify that Prowler App can successfully connect to your provider:

​

Step 6: Scan started

After successfully adding and testing your credentials, Prowler will start scanning your cloud environment, click the Go to Scans button to see the progress:

​

Step 7: Monitor Scan Progress

Track the progress of your scan in the Scans section:

​

Step 8: Analyze the Findings

While the scan is running, start exploring the findings in these sections:

• Overview: High-level summary of the scans.
• Compliance: Insights into compliance status.
• Issues: Types of issues detected.
• Browse All Findings: Detailed list of findings detected, where you can filter by severity, service, and more.

To view all new findings that have not been seen prior to this scan, click the Delta filter and select new. To view all changed findings that have had a status change (from PASS to FAIL for example), click the Delta filter and select changed.

​

Step 9: Download the Outputs

Once a scan is complete, navigate to the Scan Jobs section to download the output files generated by Prowler: 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. To download these files, click the Download button. This button becomes available only after the scan has finished. 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.

​

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.

• Find the Framework report you need.
• Click its Download icon to retrieve that report’s CSV file with all the detailed findings.