{ "$schema": "https://mintlify.com/docs.json", "theme": "mint", "name": "Prowler Documentation", "colors": { "primary": "#000000", "light": "#10B981", "dark": "#10B981" }, "favicon": "/favicon.ico", "logo": { "dark": "/images/prowler-logo-white.png", "light": "/images/prowler-logo-black.png" }, "navigation": { "tabs": [ { "tab": "Getting Started", "groups": [ { "group": "Welcome", "pages": [ "introduction" ] }, { "group": "Prowler Cloud", "pages": [ "getting-started/products/prowler-cloud", "getting-started/products/prowler-cloud-pricing", "getting-started/products/prowler-cloud-aws-marketplace", "getting-started/goto/prowler-cloud", "getting-started/goto/prowler-api-reference" ] }, { "group": "Prowler CLI", "pages": [ "getting-started/products/prowler-cli", "getting-started/installation/prowler-cli", "getting-started/basic-usage/prowler-cli" ] }, { "group": "Prowler App", "pages": [ "getting-started/products/prowler-app", "getting-started/installation/prowler-app", "getting-started/basic-usage/prowler-app" ] }, { "group": "Prowler Lighthouse AI", "pages": [ "user-guide/tutorials/prowler-app-lighthouse" ] }, { "group": "Prowler MCP Server", "pages": [ "getting-started/products/prowler-mcp", "getting-started/installation/prowler-mcp", "getting-started/basic-usage/prowler-mcp", "getting-started/basic-usage/prowler-mcp-tools" ] }, { "group": "Prowler Hub", "pages": [ "getting-started/products/prowler-hub", "getting-started/goto/prowler-hub" ] }, { "group": "Prowler vs. Others", "pages": [ "getting-started/comparison/index", "getting-started/comparison/awssecurityhub", "getting-started/comparison/gcp", "getting-started/comparison/microsoftdefender", "getting-started/comparison/microsoftsentinel" ] } ] }, { "tab": "Guides", "groups": [ { "group": "Prowler Cloud/App", "pages": [ "user-guide/tutorials/prowler-app", { "group": "Authentication", "pages": [ "user-guide/tutorials/prowler-app-social-login", "user-guide/tutorials/prowler-app-sso" ] }, "user-guide/tutorials/prowler-app-rbac", "user-guide/tutorials/prowler-app-api-keys", "user-guide/tutorials/prowler-app-mute-findings", { "group": "Integrations", "expanded": true, "pages": [ "user-guide/tutorials/prowler-app-s3-integration", "user-guide/tutorials/prowler-app-security-hub-integration", "user-guide/tutorials/prowler-app-jira-integration" ] }, "user-guide/tutorials/prowler-app-lighthouse", { "group": "Tutorials", "pages": [ "user-guide/tutorials/prowler-app-sso-entra", "user-guide/tutorials/bulk-provider-provisioning", "user-guide/tutorials/aws-organizations-bulk-provisioning" ] } ] }, { "group": "CLI", "pages": [ "user-guide/cli/tutorials/misc", "user-guide/cli/tutorials/reporting", "user-guide/cli/tutorials/compliance", "user-guide/cli/tutorials/dashboard", "user-guide/cli/tutorials/configuration_file", "user-guide/cli/tutorials/logging", "user-guide/cli/tutorials/mutelist", { "group": "Integrations", "pages": [ "user-guide/providers/aws/securityhub", "user-guide/cli/tutorials/integrations", "user-guide/providers/aws/s3" ] }, "user-guide/cli/tutorials/fixer", "user-guide/cli/tutorials/check-aliases", "user-guide/cli/tutorials/custom-checks-metadata", "user-guide/cli/tutorials/pentesting", "user-guide/cli/tutorials/scan-unused-services", "user-guide/cli/tutorials/quick-inventory", { "group": "Tutorials", "pages": [ "user-guide/cli/tutorials/parallel-execution" ] } ] }, { "group": "Providers", "pages": [ { "group": "AWS", "pages": [ "user-guide/providers/aws/getting-started-aws", "user-guide/providers/aws/authentication", "user-guide/providers/aws/role-assumption", "user-guide/providers/aws/organizations", "user-guide/providers/aws/regions-and-partitions", "user-guide/providers/aws/tag-based-scan", "user-guide/providers/aws/resource-arn-based-scan", "user-guide/providers/aws/boto3-configuration", "user-guide/providers/aws/threat-detection", "user-guide/providers/aws/cloudshell", "user-guide/providers/aws/multiaccount" ] }, { "group": "Azure", "pages": [ "user-guide/providers/azure/getting-started-azure", "user-guide/providers/azure/authentication", "user-guide/providers/azure/use-non-default-cloud", "user-guide/providers/azure/subscriptions", "user-guide/providers/azure/create-prowler-service-principal" ] }, { "group": "Google Cloud", "pages": [ "user-guide/providers/gcp/getting-started-gcp", "user-guide/providers/gcp/authentication", "user-guide/providers/gcp/projects", "user-guide/providers/gcp/organization", "user-guide/providers/gcp/retry-configuration" ] }, { "group": "Kubernetes", "pages": [ "user-guide/providers/kubernetes/in-cluster", "user-guide/providers/kubernetes/outside-cluster", "user-guide/providers/kubernetes/misc" ] }, { "group": "Microsoft 365", "pages": [ "user-guide/providers/microsoft365/getting-started-m365", "user-guide/providers/microsoft365/authentication", "user-guide/providers/microsoft365/use-of-powershell" ] }, { "group": "GitHub", "pages": [ "user-guide/providers/github/getting-started-github", "user-guide/providers/github/authentication" ] }, { "group": "IaC", "pages": [ "user-guide/providers/iac/getting-started-iac", "user-guide/providers/iac/authentication" ] }, { "group": "MongoDB Atlas", "pages": [ "user-guide/providers/mongodbatlas/getting-started-mongodbatlas", "user-guide/providers/mongodbatlas/authentication" ] }, { "group": "LLM", "pages": [ "user-guide/providers/llm/getting-started-llm" ] }, { "group": "Oracle Cloud Infrastructure", "pages": [ "user-guide/providers/oci/getting-started-oci", "user-guide/providers/oci/authentication" ] } ] }, { "group": "Compliance", "pages": [ "user-guide/compliance/tutorials/threatscore" ] } ] }, { "tab": "Developer Guide", "groups": [ { "group": "Concepts", "pages": [ "developer-guide/introduction", "developer-guide/provider", "developer-guide/services", "developer-guide/checks", "developer-guide/outputs", "developer-guide/integrations", "developer-guide/security-compliance-framework", "developer-guide/lighthouse" ] }, { "group": "Providers", "pages": [ "developer-guide/aws-details", "developer-guide/azure-details", "developer-guide/gcp-details", "developer-guide/kubernetes-details", "developer-guide/m365-details", "developer-guide/github-details", "developer-guide/llm-details" ] }, { "group": "Miscellaneous", "pages": [ "developer-guide/documentation", { "group": "Testing", "pages": [ "developer-guide/unit-testing", "developer-guide/integration-testing" ] }, "developer-guide/debugging", "developer-guide/configurable-checks", "developer-guide/renaming-checks", "developer-guide/check-metadata-guidelines" ] } ] }, { "tab": "Security", "pages": [ "security" ] }, { "tab": "Contact Us", "pages": [ "contact" ] }, { "tab": "Troubleshooting", "pages": [ "troubleshooting" ] }, { "tab": "API Reference", "groups": [ { "group": "Getting Started", "pages": [ "api-reference/introduction" ] }, { "group": "API Endpoints", "pages": [ { "group": "Authentication", "pages": [ "api-reference/tokens/create", "api-reference/tokens/refresh", "api-reference/tokens/switch" ] }, { "group": "API Keys", "pages": [ "api-reference/api-keys/list", "api-reference/api-keys/create", "api-reference/api-keys/retrieve", "api-reference/api-keys/update", "api-reference/api-keys/revoke" ] }, { "group": "Users", "pages": [ "api-reference/users/me", "api-reference/users/list", "api-reference/users/create", "api-reference/users/retrieve", "api-reference/users/update", "api-reference/users/delete", "api-reference/users/memberships-list", "api-reference/users/memberships-retrieve", "api-reference/users/add-roles", "api-reference/users/update-roles", "api-reference/users/remove-roles" ] }, { "group": "Tenants", "pages": [ "api-reference/tenants/list", "api-reference/tenants/create", "api-reference/tenants/retrieve", "api-reference/tenants/update", "api-reference/tenants/delete", { "group": "Memberships", "pages": [ "api-reference/tenants/memberships/list", "api-reference/tenants/memberships/delete" ] }, { "group": "Invitations", "pages": [ "api-reference/tenants/invitations-list", "api-reference/tenants/invitations-create", "api-reference/tenants/invitations/retrieve", "api-reference/tenants/invitations/update", "api-reference/tenants/invitations/delete" ] } ] }, { "group": "Invitations", "pages": [ "api-reference/invitations/accept" ] }, { "group": "Provider Groups", "pages": [ "api-reference/provider-groups/list", "api-reference/provider-groups/create", "api-reference/provider-groups/retrieve", "api-reference/provider-groups/update", "api-reference/provider-groups/delete", "api-reference/provider-groups/add-providers", "api-reference/provider-groups/update-providers", "api-reference/provider-groups/remove-providers" ] }, { "group": "Roles", "pages": [ "api-reference/roles/list", "api-reference/roles/create", "api-reference/roles/retrieve", "api-reference/roles/update", "api-reference/roles/delete", "api-reference/roles/add-provider-groups", "api-reference/roles/update-provider-groups", "api-reference/roles/remove-provider-groups" ] }, { "group": "SAML Configuration", "pages": [ "api-reference/saml/list", "api-reference/saml/create", "api-reference/saml/retrieve", "api-reference/saml/update", "api-reference/saml/delete" ] }, { "group": "Providers", "pages": [ "api-reference/providers/list", "api-reference/providers/create", "api-reference/providers/retrieve", "api-reference/providers/update", "api-reference/providers/delete", "api-reference/providers/check-connection", { "group": "Provider Secrets", "pages": [ "api-reference/providers/secrets/list", "api-reference/providers/secrets/create", "api-reference/providers/secrets/retrieve", "api-reference/providers/secrets/update", "api-reference/providers/secrets/delete" ] } ] }, { "group": "Scans", "pages": [ "api-reference/scans/list", "api-reference/scans/create", "api-reference/scans/retrieve", "api-reference/scans/update", "api-reference/scans/compliance", "api-reference/scans/report", "api-reference/scans/threatscore" ] }, { "group": "Findings", "pages": [ "api-reference/findings/list", "api-reference/findings/retrieve", "api-reference/findings/latest", "api-reference/findings/services-regions", "api-reference/findings/metadata", "api-reference/findings/metadata-latest" ] }, { "group": "Resources", "pages": [ "api-reference/resources/list", "api-reference/resources/retrieve", "api-reference/resources/latest", "api-reference/resources/metadata", "api-reference/resources/metadata-latest" ] }, { "group": "Compliance Overview", "pages": [ "api-reference/compliance/list", "api-reference/compliance/requirements", "api-reference/compliance/attributes", "api-reference/compliance/metadata" ] }, { "group": "Overviews", "pages": [ "api-reference/overviews/findings", "api-reference/overviews/findings-severity", "api-reference/overviews/providers", "api-reference/overviews/providers-count", "api-reference/overviews/services" ] }, { "group": "Integrations", "pages": [ "api-reference/integrations/list", "api-reference/integrations/create", "api-reference/integrations/retrieve", "api-reference/integrations/update", "api-reference/integrations/delete", "api-reference/integrations/check-connection", "api-reference/integrations/jira-dispatch" ] }, { "group": "Lighthouse AI", "pages": [ { "group": "Providers", "pages": [ "api-reference/lighthouse/providers/list", "api-reference/lighthouse/providers/create", "api-reference/lighthouse/providers/retrieve", "api-reference/lighthouse/providers/update", "api-reference/lighthouse/providers/delete", "api-reference/lighthouse/providers/test-connection", "api-reference/lighthouse/providers/refresh-models" ] }, { "group": "Configurations", "pages": [ "api-reference/lighthouse/configurations/list", "api-reference/lighthouse/configurations/create", "api-reference/lighthouse/configurations/retrieve", "api-reference/lighthouse/configurations/update", "api-reference/lighthouse/configurations/delete", "api-reference/lighthouse/configurations/test-connection" ] }, { "group": "Models", "pages": [ "api-reference/lighthouse/models/list", "api-reference/lighthouse/models/retrieve" ] }, "api-reference/lighthouse/config-list", "api-reference/lighthouse/config-update" ] }, { "group": "Processors", "pages": [ "api-reference/processors/list", "api-reference/processors/create", "api-reference/processors/retrieve", "api-reference/processors/update", "api-reference/processors/delete" ] }, { "group": "Schedules", "pages": [ "api-reference/schedules/create-daily" ] }, { "group": "Tasks", "pages": [ "api-reference/tasks/list", "api-reference/tasks/retrieve", "api-reference/tasks/delete" ] } ] } ] }, { "tab": "About Us", "icon": "/favicon.ico", "href": "https://prowler.com/about#team" }, { "tab": "Changelog", "icon": "github", "href": "https://github.com/prowler-cloud/prowler/releases" }, { "tab": "Public Roadmap", "href": "https://roadmap.prowler.com/" } ], "global": { "anchors": [ { "anchor": "GitHub", "href": "https://github.com/prowler-cloud/prowler", "icon": "github" }, { "anchor": "Slack", "href": "https://goto.prowler.com/slack", "icon": "slack" }, { "anchor": "YouTube", "href": "https://www.youtube.com/@prowlercloud", "icon": "youtube" } ] } }, "navbar": { "links": [ { "label": "Prowler Hub", "href": "https://hub.prowler.com" }, { "label": "Prowler Cloud", "href": "https://cloud.prowler.com", "style": "primary" } ] }, "analytics": { "ga4": { "measurementId": "G-KBKV70W5Y2" } }, "feedback": { "thumbsRating": true, "suggestEdit": true, "raiseIssue": true }, "footer": { "socials": { "x-twitter": "https://x.com/prowlercloud", "github": "https://github.com/prowler-cloud/prowler", "linkedin": "https://www.linkedin.com/company/prowler-security", "youtube": "https://www.youtube.com/@prowlercloud", "slack": "https://goto.prowler.com/slack", "website": "https://prowler.com" } }, "openapi": "/api-reference/openapi.yaml", "api": { "baseUrl": "https://api.prowler.com", "auth": { "method": "bearer" }, "playground": { "mode": "simple" } }, "redirects": [ { "source": "/projects/prowler-open-source/en/latest/tutorials/prowler-app-lighthouse", "destination": "/user-guide/tutorials/prowler-app-lighthouse" }, { "source": "/projects/prowler-open-source/en/latest/developer-guide/introduction", "destination": "/developer-guide/introduction" }, { "source": "/projects/prowler-open-source/en/latest/tutorials/aws/getting-started-aws", "destination": "/user-guide/providers/aws/getting-started-aws" }, { "source": "/projects/prowler-open-source/en/latest/tutorials/azure/getting-started-azure", "destination": "/user-guide/providers/azure/getting-started-azure" }, { "source": "/projects/prowler-open-source/en/latest/tutorials/gcp/getting-started-gcp", "destination": "/user-guide/providers/gcp/getting-started-gcp" }, { "source": "/projects/prowler-open-source/en/latest/tutorials/microsoft365/getting-started-m365", "destination": "/user-guide/providers/microsoft365/getting-started-m365" }, { "source": "/projects/prowler-open-source/en/latest/tutorials/github/getting-started-github", "destination": "/user-guide/providers/github/getting-started-github" }, { "source": "/projects/prowler-open-source/en/latest/tutorials/prowler-app-sso", "destination": "/user-guide/tutorials/prowler-app-sso" }, { "source": "/projects/prowler-open-source/en/latest", "destination": "/introduction" }, { "source": "/projects/prowler-saas/en/latest/:slug*", "destination": "https://docs.prowler.pro/en/latest/:slug*" }, { "source": "/projects/prowler-open-source/en/latest/tutorials/:slug*", "destination": "/user-guide/tutorials/:slug*" } ] }