Start Authorized VulKill Security Scan
vulkill_start_scanReserves scan credits and dispatches an authorized VulKill security scan job for owned, client, or open-source targets, rolling back if engine startup fails.
Instructions
Atomically reserve credits and dispatch an authorized security scan job to the VulKill scanner engine. Call only to execute a real scan after vulkill_check_credits or vulkill_scan_guided_interactive. Do not use for dry-run estimates or to poll an active job (use vulkill_complete_scan instead). Requires liabilityAccepted=true and authorizationScope ('own_asset' for self-owned targets, 'authorized_organization_or_client' for contracted engagements, or 'open_source_or_bounty' for public repos). Each file reserves 1 file credit across ceil(files / 5000) shards and each site reserves 1 site credit, while sites > 0 or mode='web' requires an HTTPS targetUrl verified in https://app.vulkill.com/targets. Passing idempotencyKey binds the reservation to (mode, files, sites, targetUrl) to replay scanId on retries and reject mismatched reuse. Requires VULKILL_API_KEY or OAuth 2.1 auth, deducts active credit_periods quota before dispatch, and rolls back if engine startup fails.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| mode | No | Execution profile ('auto', 'source', 'semantic', 'infrastructure', or 'web'; default 'auto'). | auto |
| files | No | Repository file count to scan (0 to 100,000,000, default 0). | |
| sites | No | Verified live site count to scan (0 to 10,000, default 0). | |
| targetUrl | No | Repository URL or HTTPS web origin (for example, 'https://example.com'). | |
| targetName | No | Project or repository label (1–120 characters, default 'MCP Tarama Hedefi'). | |
| idempotencyKey | No | Optional client idempotency key (8–120 ASCII alphanumeric/dash/underscore characters). | |
| liabilityAccepted | Yes | Boolean confirmation of explicit legal authorization and liability acceptance. | |
| authorizationScope | Yes | Legal authorization basis ('own_asset', 'authorized_organization_or_client', or 'open_source_or_bounty'). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ok | Yes | True when credits were reserved and the scanner engine accepted the job. | |
| scanId | Yes | Unique VulKill scan report identifier (pass to vulkill_complete_scan). | |
| status | Yes | Authoritative scan state ('running' or 'completed'). | |
| reportUrl | Yes | URL where the live report and findings can be viewed (https://app.vulkill.com/scans). | |
| engineJobId | Yes | Authoritative remote scanner engine job identifier bound to scanId. | |
| sitesCharged | Yes | Live-site credits atomically reserved for this scan. | |
| creditsCharged | Yes | File credits atomically reserved for this scan. |