bestdefense-io/BestDefense Vortex Scan
Trigger BestDefense security & performance scans on pull requests
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| api-key | BestDefense Organization API key (Bearer token) | yes | — |
| target-id | BestDefense target/site UUID | yes | — |
| target-url | URL to scan (e.g., preview environment URL or staging URL) | yes | — |
| scan-types | Comma-separated list of scan types: security, seo, dns, whois | no | security |
| intensity | Scan intensity: quick | standard | thorough | no | standard |
| vortex-mode | Scan engine mode: analog | ai | no | analog |
| fail-check-on | Minimum severity level that fails the check: critical | high | medium | low | none | no | high |
| bestdefense-url | BestDefense platform base URL. Multi-tenant (default): https://app.bestdefense.io Single-tenant example: https://acme.bestdefense.io | no | https://app.bestdefense.io |
| app-backend-url | URL of the BestDefense GitHub App backend that handles scan registration. Leave empty to use the same host as bestdefense-url (recommended for both multi-tenant and single-tenant deployments). Override only if your scan registration endpoint is on a separate host. | no | "" |
| github-token | GitHub token used to create Check Runs and post PR comments. Defaults to the built-in GITHUB_TOKEN. Override only if you need elevated permissions (e.g. checks:write on a forked repo). | no | ${{ github.token }} |
Outputs
| name | description |
|---|---|
| report-id | BestDefense report UUID |
| report-url | URL to view the full report |
| check-run-id | GitHub Check Run ID |