Prowler Cloud

Prowler Cloud is a web application that simplifies running Prowler. This tutorial will guide you through setting up and using it.

​

Accessing Prowler Cloud and API Documentation

Sign in at cloud.prowler.com. The API documentation is available 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 Cloud. 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
• Oracle Cloud Infrastructure (OCI)

Steps to add a provider:

1. Navigate to Settings > Providers.
2. Click Add Provider 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

To verify the credentials, click the connect action at the bottom of the same step (for example, “Connect account”, “Connect subscription” or “Connect project”). Prowler saves the provider and its credentials and tests the connection in that single action. When the test succeeds, the wizard moves straight to launching the scan. When it fails, the reason appears above the form and the values stay in place: click “Retry connection” to test again, or correct a field, which brings back the connect action, and click it. Neither adds the provider twice.

​

Step 6: Scan Started

Once the connection test succeeds, the wizard moves to the launch step, since the provider is already saved. To start the first scan, click “Launch scan”, or “Save and launch scan” when scanning on a schedule. The Scans section shows the scan in 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.
• 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 Scans 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-OCSF, 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.

​

Running the Same Steps on Prowler Local Server

Prowler Local Server is the self-hosted version of Prowler Cloud, and every step in this guide works the same way on it. See Prowler product families for every official product name. After installing Prowler Local Server, access it at http://localhost:3000 and the auto-generated Prowler API documentation at http://localhost:8080/api/v1/docs.