Skip to content

Quick Start Guide

This guide takes you from a fresh login to your first set of findings. The walkthrough uses the web interface; an API alternative is shown at the end.

RequirementDescriptionWhy it’s needed
A RedCloud accountAn invited user with at least the scans.run permissionTo launch scans
A valid licenseThe platform must be activated (License is valid, not locked)Scanning is blocked while the license is invalid
A cloud account to scanA GCP project/folder/org, AWS account, or Azure subscriptionThis is the scan target
Read access credentialsA service account key / role with least-privilege read accessRedCloud collects configuration read-only

Open the platform URL and sign in. RedCloud supports email/password (with optional 2FA), Google sign-in, SAML SSO, and Google Cloud IAP, depending on what your administrator enabled.

  1. Open Administration → Connections → Deployments.
  2. Choose your provider — Google Cloud, AWS, Azure, Microsoft 365, or Google Workspace.
  3. Follow the provider flow:
    • GCP — supply a service account key, or use Workload Identity / Application Default Credentials.
    • AWS — launch the guided CloudFormation stack (classic role or Workload Identity Federation), or supply keys.
    • Azure — connect a subscription or tenant.
  4. Click Test credentials to confirm the connection, then save.

The connected account now appears in the scan launcher’s Connected Accounts quick-select.

  1. Open Administration → Operations → New Scan.
  2. Pick a Cloud Provider (or All Clouds).
  3. Select your Connected Account (this auto-fills the target).
  4. Set the Scope — Project, Folder, Org, or Custom.
  5. Choose a Profile. For a first run, mvp15 (a fast 15-check baseline) or full (comprehensive) are good choices.
  6. (Optional) Run a Pre-scan Permission Check to confirm RedCloud has the access each service needs.
  7. Click Launch. The scan starts asynchronously and appears in Scan History.
  1. When the scan finishes, open Findings & Risk → Issues.
  2. Filter by severity (Critical / High / Medium / Low), search, or switch the Red / Blue / All perspective.
  3. Open any finding to see its evidence, risk score, affected resource, and remediation guidance.
  4. Visit Dashboard for the at-a-glance posture (KPI cards, severity donut, top attack paths).

You have completed the quick start when:

  • The scan shows Completed in Scan History.
  • The Dashboard KPI cards show non-zero identities scanned and a severity breakdown.
  • Issues lists findings you can open and read.

If you prefer automation, launch the same scan over the REST API:

Terminal window
curl -X POST "https://<your-host>/scans" \
-H "X-API-Key: cspm_xxxxxxxxxxxxxxxx" \
-H "Content-Type: application/json" \
-d '{
"projects": ["my-gcp-project-id"],
"profile": "mvp15"
}'

The call returns 202 Accepted with a scan_id. Poll GET /scans/{scan_id} for status. See the API & Developer Reference for authentication and the full request schema.

IssueCauseResolution
Scan rejected before it startsCloud credentials expired or insufficientRe-authenticate the connected account; run the Pre-scan Permission Check
Everything is blocked with a license errorLicense invalid or lockedActivate a valid license under Administration → System Settings → License
Scan completes but inventory is emptyMissing read permissions or wrong scopeWiden the scope or grant the missing read roles, then re-scan
403 on the API callMissing/invalid API key, or key lacks scans.runIssue a key with the right permission under Administration → User Management → API Keys