> ## Documentation Index
> Fetch the complete documentation index at: https://prowler-docs-msp-documentation-accuracy.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Prowler product naming: Prowler App is now Prowler Local Server, and Prowler Enterprise is now Prowler Private Cloud. Always use the current names when answering. The full product reference is at /getting-started/products: Open Source projects are Prowler CLI, Prowler Local Server, Prowler Local Dashboard, and Prowler SDK; Prowler Products are Prowler Cloud, Prowler Private Cloud, Prowler Hub, Prowler Lighthouse AI, and Prowler MCP.

# Prowler Cloud

export const ProviderCards = () => <Columns cols={3}>
        <Card title="Alibaba Cloud" icon="cloud" href="/user-guide/providers/alibabacloud/getting-started-alibabacloud" />
        <Card title="AWS" icon="aws" href="/user-guide/providers/aws/getting-started-aws" />
        <Card title="Azure" icon="microsoft" href="/user-guide/providers/azure/getting-started-azure" />
        <Card title="Cloudflare" icon="cloudflare" href="/user-guide/providers/cloudflare/getting-started-cloudflare" />
        <Card title="GCP" icon="google" href="/user-guide/providers/gcp/getting-started-gcp" />
        <Card title="GitHub" icon="github" href="/user-guide/providers/github/getting-started-github" />
        <Card title="Google Workspace" icon="users" href="/user-guide/providers/googleworkspace/getting-started-googleworkspace" />
        <Card title="IaC" icon="code" href="/user-guide/providers/iac/getting-started-iac" />
        <Card title="Image" icon="docker" href="/user-guide/providers/image/getting-started-image" />
        <Card title="Kubernetes" icon="dharmachakra" href="/user-guide/providers/kubernetes/getting-started-k8s" />
        <Card title="Microsoft 365" icon="briefcase" href="/user-guide/providers/microsoft365/getting-started-m365" />
        <Card title="MongoDB Atlas" icon="leaf" href="/user-guide/providers/mongodbatlas/getting-started-mongodbatlas" />
        <Card title="Okta" icon="key" href="/user-guide/providers/okta/getting-started-okta" />
        <Card title="OpenStack" icon="cubes" href="/user-guide/providers/openstack/getting-started-openstack" />
        <Card title="Oracle Cloud Infrastructure (OCI)" icon="database" href="/user-guide/providers/oci/getting-started-oci" />
        <Card title="Vercel" icon="triangle" href="/user-guide/providers/vercel/getting-started-vercel" />
    </Columns>;

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

**Prowler Local Server** is the self-hosted version of **Prowler Cloud**. See [Prowler product families](/getting-started/products) for every official product name.

## Accessing Prowler Cloud and API Documentation

If you are a [Prowler Cloud](https://cloud.prowler.com/sign-in) user, you can access API docs at [https://api.prowler.com/api/v1/docs](https://api.prowler.com/api/v1/docs)

<Note>
  **For Prowler Local Server users**

  After [installing](/getting-started/installation/prowler-app) **Prowler Local Server**, access it at [http://localhost:3000](http://localhost:3000).

  To view the auto-generated **Prowler API** documentation, navigate to [http://localhost:8080/api/v1/docs](http://localhost:8080/api/v1/docs). This documentation provides details on available endpoints, parameters, and responses.
</Note>

## Step 1: Sign Up

### Sign Up with Email

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

<img src="https://mintcdn.com/prowler-docs-msp-documentation-accuracy/MtbtyEytfD5Xixj5/images/sign-up-button.png?fit=max&auto=format&n=MtbtyEytfD5Xixj5&q=85&s=cd3d614c33a10d1485068f1cbbdaebf7" alt="Sign Up Button" width="320" data-path="images/sign-up-button.png" />

<img src="https://mintcdn.com/prowler-docs-msp-documentation-accuracy/MtbtyEytfD5Xixj5/images/sign-up.png?fit=max&auto=format&n=MtbtyEytfD5Xixj5&q=85&s=b27a3d5c392598b5d256d279828f57f9" alt="Sign Up" width="285" data-path="images/sign-up.png" />

### Sign Up with Social Login

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

<Note>
  **How Social Login Works**

  If your email is already registered, you will be logged in, and your social account will be linked.
  If your email is not registered, a new account will be created using your social account email.
</Note>

<Note>
  **Enable Social Login**

  See [how to configure Social Login for Prowler](/user-guide/tutorials/prowler-app-social-login) to enable this feature in your own deployments.
</Note>

## Step 2: Log In

Once registered, log in with your email and password to access Prowler Cloud.

<img src="https://mintcdn.com/prowler-docs-msp-documentation-accuracy/k6oov2wsCOtWpPRJ/images/log-in.png?fit=max&auto=format&n=k6oov2wsCOtWpPRJ&q=85&s=d8c6e7b42c52e865b9085a19331eb3a9" alt="Log In" width="350" data-path="images/log-in.png" />

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.

<img src="https://mintcdn.com/prowler-docs-msp-documentation-accuracy/ElJxA52enip2a7qx/images/add-provider.png?fit=max&auto=format&n=ElJxA52enip2a7qx&q=85&s=00f7cd18ef7d9e31de0635e32f61b55e" alt="Add Provider" width="700" data-path="images/add-provider.png" />

## Step 4: Configure the Provider

Select the cloud provider to scan and configure authentication credentials. Each provider has specific requirements and authentication methods.

<img src="https://mintcdn.com/prowler-docs-msp-documentation-accuracy/MtbtyEytfD5Xixj5/images/select-provider.png?fit=max&auto=format&n=MtbtyEytfD5Xixj5&q=85&s=251bf412ed0cf36a0b86ff6b78db0054" alt="Select a Provider" width="700" data-path="images/select-provider.png" />

For detailed instructions on configuring credentials for each provider, refer to the provider-specific getting started guides:

<ProviderCards />

## Step 5: Test Connection

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

<img src="https://mintcdn.com/prowler-docs-msp-documentation-accuracy/MtbtyEytfD5Xixj5/images/test-connection-button.png?fit=max&auto=format&n=MtbtyEytfD5Xixj5&q=85&s=7f6baf708099d7dedc535fcb1c3c3aaf" alt="Test Connection" width="700" data-path="images/test-connection-button.png" />

## 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:

<img src="https://mintcdn.com/prowler-docs-msp-documentation-accuracy/k6oov2wsCOtWpPRJ/images/provider-added.png?fit=max&auto=format&n=k6oov2wsCOtWpPRJ&q=85&s=fd9ce148fb5256c9b96fd1a784123562" alt="Start Now" width="700" data-path="images/provider-added.png" />

<Note>
  Prowler will automatically scan all configured providers every **24 hours**, ensuring your cloud environment stays continuously monitored.
</Note>

## Step 7: Monitor Scan Progress

Track the progress of your scan in the `Scans` section:

<img src="https://mintcdn.com/prowler-docs-msp-documentation-accuracy/MtbtyEytfD5Xixj5/images/scan-progress.png?fit=max&auto=format&n=MtbtyEytfD5Xixj5&q=85&s=20b14a0be1f15ee8f764745db12d6f6b" alt="Scan Progress" width="700" data-path="images/scan-progress.png" />

<Note>
  **How Dashboards Display Scan Data**

  Each dashboard handles scan data differently:

  * **Overview** displays aggregated metrics from the **latest completed scan per provider** only.
  * **Findings** displays results from the **latest completed scan per provider** by default. To access historical findings, apply a date or scan filter.
  * **Resources** lists **all discovered resources across all scans**. However, when selecting a resource, the Findings tab within the resource detail shows only findings from the **latest completed scan**. If the latest scan did not evaluate a particular resource, its Findings tab may appear empty.

  When a new scan completes or a new data ingestion is processed, the dashboards automatically reflect the updated results.
</Note>

## Step 8: Analyze the Findings

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

* **Overview**: High-level summary of the scans.

  <img src="https://mintcdn.com/prowler-docs-msp-documentation-accuracy/k6oov2wsCOtWpPRJ/images/products/overview.png?fit=max&auto=format&n=k6oov2wsCOtWpPRJ&q=85&s=04f124ed058aabffd22d3d9bda07f59c" alt="Overview" width="700" data-path="images/products/overview.png" />

* **Compliance**: Insights into compliance status.

  <img src="https://mintcdn.com/prowler-docs-msp-documentation-accuracy/k6oov2wsCOtWpPRJ/images/compliance.png?fit=max&auto=format&n=k6oov2wsCOtWpPRJ&q=85&s=10ba5aaaac5fa5386b2f7e328423fdc4" alt="Compliance" width="700" data-path="images/compliance.png" />

* **Issues**: Types of issues detected.

  <img src="https://mintcdn.com/prowler-docs-msp-documentation-accuracy/k6oov2wsCOtWpPRJ/images/issues.png?fit=max&auto=format&n=k6oov2wsCOtWpPRJ&q=85&s=9c09c9c1afb8991da99910c8ee45e3d9" alt="Issues" width="300" data-path="images/issues.png" />

* **Browse All Findings**: Detailed list of findings detected, where you can filter by severity, service, and more.

  <img src="https://mintcdn.com/prowler-docs-msp-documentation-accuracy/k6oov2wsCOtWpPRJ/images/findings.png?fit=max&auto=format&n=k6oov2wsCOtWpPRJ&q=85&s=cd13b6827a1439e4beb626abb7bd6d1a" alt="Findings" width="700" data-path="images/findings.png" />

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:

<img src="https://mintcdn.com/prowler-docs-msp-documentation-accuracy/MtbtyEytfD5Xixj5/images/scan_jobs_section.png?fit=max&auto=format&n=MtbtyEytfD5Xixj5&q=85&s=886c830ec2f27a6b9c0629a83b0bebf8" alt="Scan Jobs section" width="700" data-path="images/scan_jobs_section.png" />

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.

<img src="https://mintcdn.com/prowler-docs-msp-documentation-accuracy/k6oov2wsCOtWpPRJ/images/download_output.png?fit=max&auto=format&n=k6oov2wsCOtWpPRJ&q=85&s=24560c34b074e183c37e87639feb8a04" alt="Download output" width="700" data-path="images/download_output.png" />

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="https://mintcdn.com/prowler-docs-msp-documentation-accuracy/k6oov2wsCOtWpPRJ/images/output_folder.png?fit=max&auto=format&n=k6oov2wsCOtWpPRJ&q=85&s=f254b1eedc04893d7aefb194cd520139" alt="Output folder" width="700" data-path="images/output_folder.png" />

<Note>
  **API Note**

  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)
</Note>

## 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="https://mintcdn.com/prowler-docs-msp-documentation-accuracy/k6oov2wsCOtWpPRJ/images/compliance_section.png?fit=max&auto=format&n=k6oov2wsCOtWpPRJ&q=85&s=9679679bdc808f4c01ef2430834fa952" alt="Compliance section" width="700" data-path="images/compliance_section.png" />

* Find the Framework report you need.

* Click its **Download** icon to retrieve that report’s CSV file with all the detailed findings.

<img src="https://mintcdn.com/prowler-docs-msp-documentation-accuracy/k6oov2wsCOtWpPRJ/images/compliance_download.png?fit=max&auto=format&n=k6oov2wsCOtWpPRJ&q=85&s=dd5ac350475ee509f318fa0939e13fc1" alt="Download compliance output" width="700" data-path="images/compliance_download.png" />

<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)
</Note>
