Skip to main content

Quick Start (First Validation Run)

Outcome​

Complete one end-to-end validation cycle:

  1. Platform is healthy.
  2. First scan is created.
  3. Findings are visible.
  4. First report is generated.

Prerequisites​

  • Running Cyprob EE environment (demo or production-like).
  • API/UI reachable on your target host.
  • Valid user credentials.
  • A safe scan target (lab network or approved internal range).

Step 1: Verify Platform Health​

Check basic service availability before login.

curl -sS http://<CYPROB_HOST>:8080/health

Expected result: JSON response with healthy status.

Note: In some reverse-proxy deployments, health endpoint may be exposed as /healthz.

Step 2: Login and Capture Context​

Authenticate and collect token + organization context.

curl -sS -X POST http://<CYPROB_HOST>:8080/api/v1/auth/login \
  -H 'Content-Type: application/json' \
  -d '{"email":"<USER_EMAIL>","password":"<USER_PASSWORD>"}'

From response, capture:

  • token
  • user.memberships[*].org_id (the organization for scan operations)

Demo-only default credentials (if using demo package):

  • Email: demo@cyprob.io
  • Password: demo123456789

Step 3: Start First Scan​

Create a scan via API.

curl -sS -X POST http://<CYPROB_HOST>:8080/api/v1/orgs/<ORG_ID>/scans \
  -H "Authorization: Bearer <TOKEN>" \
  -H 'Content-Type: application/json' \
  -d '{"target":"<TARGET>","scan_type":"network"}'

Example targets:

  • 192.168.56.0/24 (lab network)
  • 10.10.10.12 (single host)

Step 4: Track Scan Progress​

Use UI scan list/detail pages or poll API.

curl -sS -H "Authorization: Bearer <TOKEN>" \
  http://<CYPROB_HOST>:8080/api/v1/orgs/<ORG_ID>/scans

Validation criteria:

  • Scan reaches terminal state (completed/failed/cancelled).
  • Discovered assets/services or findings appear in result set.

Step 5: Validate Findings​

Fetch findings from the completed scan.

curl -sS -H "Authorization: Bearer <TOKEN>" \
  http://<CYPROB_HOST>:8080/api/v1/orgs/<ORG_ID>/scans/<SCAN_ID>/findings

Check at least:

  • Severity distribution exists.
  • Evidence/context fields are populated for actionable items.

Step 6: Generate First Report​

Create report from the same organization scope.

curl -sS -X POST http://<CYPROB_HOST>:8080/api/v1/orgs/<ORG_ID>/reports \
  -H "Authorization: Bearer <TOKEN>" \
  -H 'Content-Type: application/json' \
  -d '{"name":"first-validation-report","template_type":"executive_summary","format":"pdf","scope":{}}'

Download options:

  • Get download URL: GET /api/v1/orgs/<ORG_ID>/reports/<REPORT_ID>/download
  • Stream directly: GET /api/v1/orgs/<ORG_ID>/reports/<REPORT_ID>/stream

Evidence Checklist (Quick Start Done)​

  • Health endpoint returns healthy.
  • Auth token is issued.
  • One scan is created and finalized.
  • Findings are retrievable.
  • One report is generated and downloadable.

Next Action​

Continue with POC Playbook (Distributor/MSP) for a meeting-ready, repeatable evaluation flow.