Docs & quickstart

Quickstart

python3 -m malshield.cli add https://example.com \
  --label "Client site" --tier sentinel
python3 -m malshield.cli check        # scan all sites (cron this)
python3 -m malshield.cli incidents    # open incidents
python3 -m malshield.cli sla          # SLA clocks at risk
python3 -m malshield.cli resolve 3 --note "restored from clean backup"

API reference

• CLI commands: add, check, incidents, resolve, sla, health — plus the hosted API (POST /v1/stripe/webhook, /v1/claim, /v1/signup/free, /v1/sites, /v1/sites/{id}/check) authenticated with your ms_live_ API key. A scan's blacklist leg reports 'not configured' until the Google Safe Browsing API key is provisioned — it never guesses a verdict. Cleanup is operator-performed under the SLA clock.
• `check` — scans every site: HTTP, SSL, defacement hash, malware signatures, blacklist. Cron every 15 min.
• `sla` — lists incidents whose response window is at risk. Cron every 5 min for escalation.
• Full reference: OPENAPI.md in the repo.

The complete reference (every endpoint/command with method, path, auth, and example request/response) ships as OPENAPI.md in the product repo.

Support

Questions? Contact us — a human reads every message.