Starts a Whitebox Scan against the repositories attached to a completed or
partial cost estimation. Scans run asynchronously; the endpoint returns
immediately with a scan id for polling.
Wait until the estimation reaches completed or partial status and has a
positive total_credits value.
Submit the same repositories and branches that were included in the
estimation. Hacktron rejects scans whose repo, archive, or branch does not
match the estimate.
Ensure your organization has enough Whitebox Scan credits. Credits are
visible in Credits and billing in the
dashboard. Insufficient credits return 402 Payment Required.
A cost estimation can only be claimed by one started scan. If you need to
change repositories, archives, or branches, create a new estimate first.
{"docsConfig":{"theme":"willow","$schema":"https://mintlify.com/docs.json","name":"Hacktron Docs","colors":{"primary":"#060000","light":"#FDF6E3","dark":"#181611"},"logo":{"light":"https://mintcdn.com/hacktronai/YwinZOi1ZhshTNrW/logo/light.svg?fit=max\u0026auto=format\u0026n=YwinZOi1ZhshTNrW\u0026q=85\u0026s=6394df2b0118979b4240f0a3d716cd43","dark":"https://mintcdn.com/hacktronai/YwinZOi1ZhshTNrW/logo/dark.svg?fit=max\u0026auto=format\u0026n=YwinZOi1ZhshTNrW\u0026q=85\u0026s=0576e6ea05148ce70a461d9aa6f1d804"},"favicon":"https://mintcdn.com/hacktronai/2HX1cw_Fj0x4iRoX/favicon.png?fit=max\u0026auto=format\u0026n=2HX1cw_Fj0x4iRoX\u0026q=85\u0026s=828d46d89782771a6d4bff0d14c092b0","background":{"color":{"light":"#FDF6E3","dark":"#181611"}},"navbar":{"links":[{"href":"mailto:hello@hacktron.ai","label":"Support"},{"href":"https://trust.hacktron.ai","label":"Trust Center"}],"primary":{"type":"button","label":"Start for Free","href":"https://app.hacktron.ai"}},"footer":{"socials":{"x":"https://x.com/hacktronai","discord":"https://discord.gg/eRHCHsvDKh","github":"https://github.com/HacktronAI","linkedin":"https://linkedin.com/company/hacktron"}},"fonts":{"heading":{"family":"Titillium Web","weight":500},"body":{"family":"Inter"}},"contextual":{"options":["copy","download-spec","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"thumbnails":{"appearance":"dark"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Code Review","icon":"code-branch","href":"/code-review/overview"},{"anchor":"White-box Pentest","icon":"magnifying-glass","href":"/white-box-pentest/overview"},{"anchor":"Community","icon":"discord","href":"https://discord.gg/eRHCHsvDKh"},{"anchor":"Changelog","icon":"clock-rotate-left","href":"/changelog"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"hacktronai","hasAudioNarration":false,"actualSubdomain":"hacktronai","customDomains":["docs.hacktron.ai"],"gitSource":{"type":"github","owner":"hacktronai","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ad89c03b264ebf3acb4757f","collectionId":"3e1f648c-2171-4070-9d62-a1547ce93252","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ad89c03b264ebf3acb4757f"},"entitlements":{},"buildId":"6ad89c03b264ebf3acb4757f","clientVersion":"0.0.3964","searchFilterCounts":[{"language":"default","tag":"Platform","count":28},{"language":"default","tag":"API Reference","count":24},{"language":"default","tag":"Setup","count":13},{"language":"default","tag":"Code Review","count":11},{"language":"default","tag":"Getting started","count":8},{"language":"default","tag":"Repositories","count":7},{"language":"default","tag":"Scans","count":6},{"language":"default","tag":"Findings","count":5},{"language":"default","tag":"Overview","count":5},{"language":"default","tag":"Dependency Firewall","count":4}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"#banner *,.bg-primary-dark,.bg-primary-dark *{color:#060000!important}.dark #content-area>div{background-color:rgb(var(--background-dark))!important}.dark .prose :where(a):not(:where([class~=\"not-prose\"], [class~=\"not-prose\"] *, [class~=\"border-0\"])){border-bottom:1px solid rgb(var(--primary-light))!important}#changelog-filters-content button,.update-container span.inline-block.rounded-lg.font-medium{border-radius:9999px!important;text-transform:uppercase!important;letter-spacing:.04em!important;font-size:.6875rem!important;font-weight:600!important}.update-container span.inline-block.rounded-lg.font-medium{display:inline-block!important;padding:.1875rem .5rem!important;line-height:1.35!important;white-space:nowrap!important;background-color:rgb(var(--primary-dark)/.08)!important;color:rgb(var(--primary-dark))!important;border:1px solid rgb(var(--primary-dark)/.15)!important}#changelog-filters-content button{padding:.25rem .6875rem!important;border:1px solid transparent!important;transition:background-color .15s ease,border-color .15s ease,color .15s ease!important}#changelog-filters-content button.bg-gray-100{background-color:rgb(var(--primary-dark)/.08)!important;color:rgb(var(--primary-dark))!important;border-color:rgb(var(--primary-dark)/.15)!important}#changelog-filters-content button.bg-gray-100:hover{background-color:rgb(var(--primary-dark)/.14)!important;border-color:rgb(var(--primary-dark)/.28)!important}.dark #changelog-filters-content button.bg-gray-100,.dark .update-container span.inline-block.rounded-lg.font-medium{background-color:rgb(var(--primary-light)/.1)!important;color:rgb(var(--primary-light))!important;border-color:rgb(var(--primary-light)/.2)!important}.dark #changelog-filters-content button.bg-gray-100:hover{background-color:rgb(var(--primary-light)/.18)!important;border-color:rgb(var(--primary-light)/.38)!important}#changelog-filters-content button.bg-primary{background-color:rgb(var(--primary-dark))!important;color:rgb(var(--primary-light))!important;border-color:rgb(var(--primary-dark))!important}.dark #changelog-filters-content button.bg-primary{background-color:rgb(var(--primary-light))!important;color:rgb(var(--primary-dark))!important;border-color:rgb(var(--primary-light))!important}"}],"page":{"pagePath":"api-reference/scans/create-scan","slug":"/api-reference/scans/create-scan","pageMetadata":{"title":"Trigger a Whitebox Scan","openapi":"POST /scans","description":"Start a Whitebox Scan against one or more repositories.","href":"/api-reference/scans/create-scan"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Start a Whitebox Scan against one or more repositories.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,ol:`ol`,p:`p`,strong:`strong`,ul:`ul`,..._provideComponents(),...props.components},{Heading,Info,Warning}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Info)_missingMdxReference(`Info`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Starts a Whitebox Scan against the repositories attached to a completed or\npartial cost estimation. Scans run asynchronously; the endpoint returns\nimmediately with a scan `,_jsx(_components.code,{children:`id`}),` for polling.`]}),`\n`,_jsxs(Info,{children:[_jsx(_components.strong,{children:`Scope required`}),`: `,_jsx(_components.code,{children:`write`})]}),`\n`,_jsx(Heading,{level:`2`,id:`prerequisites`,children:`Prerequisites`}),`\n`,_jsxs(_components.ol,{children:[`\n`,_jsxs(_components.li,{children:[`Create a cost estimation with `,_jsx(_components.a,{href:`/api-reference/cost-estimations/create-cost-estimation`,children:_jsx(_components.code,{children:`POST /cost-estimations`})}),`.`]}),`\n`,_jsxs(_components.li,{children:[`Wait until the estimation reaches `,_jsx(_components.code,{children:`completed`}),` or `,_jsx(_components.code,{children:`partial`}),` status and has a\npositive `,_jsx(_components.code,{children:`total_credits`}),` value.`]}),`\n`,_jsx(_components.li,{children:`Submit the same repositories and branches that were included in the\nestimation. Hacktron rejects scans whose repo, archive, or branch does not\nmatch the estimate.`}),`\n`,_jsxs(_components.li,{children:[`Ensure your organization has enough Whitebox Scan credits. Credits are\nvisible in `,_jsx(_components.a,{href:`/white-box-pentest/billing`,children:`Credits and billing`}),` in the\ndashboard. Insufficient credits return `,_jsx(_components.code,{children:`402 Payment Required`}),`.`]}),`\n`]}),`\n`,_jsx(Warning,{children:_jsx(_components.p,{children:`A cost estimation can only be claimed by one started scan. If you need to\nchange repositories, archives, or branches, create a new estimate first.`})}),`\n`,_jsx(Heading,{level:`2`,id:`next-steps`,children:`Next steps`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`Poll `,_jsx(_components.a,{href:`/api-reference/scans/get-scan-status`,children:_jsx(_components.code,{children:`GET /scans/{id}/status`})}),` until status is `,_jsx(_components.code,{children:`completed`}),`.`]}),`\n`,_jsxs(_components.li,{children:[`Fetch findings with `,_jsx(_components.a,{href:`/api-reference/scans/list-scan-findings`,children:_jsx(_components.code,{children:`GET /scans/{id}/findings`})}),` or export them with `,_jsx(_components.a,{href:`/api-reference/scans/export-scan-findings`,children:_jsx(_components.code,{children:`GET /scans/{id}/findings/export`})}),`.`]}),`\n`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Trigger a Whitebox Scan","openapi":"POST /scans","description":"Start a Whitebox Scan against one or more repositories.","href":"/api-reference/scans/create-scan"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Prerequisites","slug":"prerequisites","depth":2,"children":[]},{"title":"Next steps","slug":"next-steps","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"RestScanController_create","parameters":[],"requestBody":"c5266f77-7ed5-486a-a959-2396d830b2ad","responses":{"201":"02dea66b-f7fb-414b-a2d2-9f00be297de3","402":"6e761dc5-f90b-47e6-be24-067ff0972fc3"},"summary":"Trigger a pentest scan","tags":["REST API - Scans"],"method":"post","type":"path","servers":["16bd04f2-d476-449c-9842-f2fa3ba6bf52"],"security":["317c51ef-08dd-45bf-81ff-b6842fe6aa02"],"path":"/scans","baseUrlOptions":["https://api.hacktron.ai/v1"],"title":"Trigger a pentest scan","description":"Start a Whitebox Scan against one or more repositories.","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"cost_estimation_id":{"type":"string","description":"Completed cost estimation UUID","isRequired":true,"uniqueKey":"cost_estimation_id","typeLabel":"string"},"repos":{"description":"Repositories to scan","type":"array","items":{"type":"object","properties":{"url":{"type":"string","description":"Repository URL","isRequired":true,"uniqueKey":"repos.items.[INDEX].url","typeLabel":"string"},"branch":{"type":"string","description":"Branch name","isRequired":true,"uniqueKey":"repos.items.[INDEX].branch","typeLabel":"string"},"source":{"type":"string","description":"Repository source","enum":["connected","public","upload"],"default":"connected","uniqueKey":"repos.items.[INDEX].source","typeLabel":"enum\u003cstring>"}},"required":["url","branch"],"uniqueKey":"repos.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"repos","typeLabel":"object[]"},"target_urls":{"description":"Target URLs for pentest","type":"array","items":{"type":"string","uniqueKey":"target_urls.items.[INDEX]","typeLabel":"string"},"uniqueKey":"target_urls","typeLabel":"string[]"},"auth_instructions":{"type":"string","description":"Target websites and browser login instructions, including URLs and credentials","maxLength":2000,"uniqueKey":"auth_instructions","typeLabel":"string"},"custom_context":{"type":"string","description":"Custom context for the pentest","maxLength":2000,"uniqueKey":"custom_context","typeLabel":"string"},"context_document_ids":{"description":"Context document UUIDs to include","type":"array","items":{"type":"string","uniqueKey":"context_document_ids.items.[INDEX]","typeLabel":"string"},"uniqueKey":"context_document_ids","typeLabel":"string[]"}},"required":["cost_estimation_id","repos"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"cost_estimation_id":"\u003cstring>","repos":[{"url":"\u003cstring>","branch":"\u003cstring>","source":"connected"}],"target_urls":["\u003cstring>"],"auth_instructions":"\u003cstring>","custom_context":"\u003cstring>","context_document_ids":["\u003cstring>"]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"02dea66b-f7fb-414b-a2d2-9f00be297de3":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"task_id":{"type":"string","isRequired":true,"uniqueKey":"task_id","typeLabel":"string"},"status":{"type":"string","isRequired":true,"uniqueKey":"status","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["id","task_id","status","message"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","task_id":"\u003cstring>","status":"\u003cstring>","message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"6e761dc5-f90b-47e6-be24-067ff0972fc3":{"description":"Insufficient credits","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"317c51ef-08dd-45bf-81ff-b6842fe6aa02":{"api-key":{"type":"apiKey","in":"header","name":"X-Api-Key","scopes":[],"schemeName":"api-key"}}},"servers":{"16bd04f2-d476-449c-9842-f2fa3ba6bf52":{"url":"https://api.hacktron.ai/v1"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"X-Api-Key","scopes":[],"schemeName":"api-key"},"schema":{"title":"X-Api-Key","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"api-key","name":"X-Api-Key"}],"title":"api-key"}]},"originalFileLocation":"openapi.json"},"subdomain":"hacktronai","siteName":"Hacktron Docs","title":"Trigger a Whitebox Scan - Hacktron Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-07-22T05:45:22.560Z","originalFileLocation":"api-reference/scans/create-scan.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Start a Whitebox Scan against one or more repositories.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Hacktron Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/hacktronai/hzWn8wWFyff5WuAd/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/hacktronai/hzWn8wWFyff5WuAd/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/hacktronai/hzWn8wWFyff5WuAd/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/hacktronai/hzWn8wWFyff5WuAd/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/hacktronai/hzWn8wWFyff5WuAd/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/hacktronai/hzWn8wWFyff5WuAd/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/hacktronai/hzWn8wWFyff5WuAd/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/hacktronai/hzWn8wWFyff5WuAd/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/hacktronai/hzWn8wWFyff5WuAd/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Trigger a Whitebox Scan - Hacktron Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Start a Whitebox Scan against one or more repositories.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Hacktron Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.hacktron.ai/api-reference/scans/create-scan\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://hacktronai.mintlify.app/_mintlify/api/og/v2?division=Scans\u0026amp;title=Trigger+a+Whitebox+Scan\u0026amp;description=Start+a+Whitebox+Scan+against+one+or+more+repositories.\u0026amp;theme=e42d35541910bc84d6a7c86c\u0026amp;signature=8180aefa02532fe673abb632f39ce22902a2653dcd8bb54c289542cd273fe823\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Trigger a Whitebox Scan - Hacktron Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Start a Whitebox Scan against one or more repositories.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://hacktronai.mintlify.app/_mintlify/api/og/v2?division=Scans\u0026amp;title=Trigger+a+Whitebox+Scan\u0026amp;description=Start+a+Whitebox+Scan+against+one+or+more+repositories.\u0026amp;theme=e42d35541910bc84d6a7c86c\u0026amp;signature=8180aefa02532fe673abb632f39ce22902a2653dcd8bb54c289542cd273fe823\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/hacktronai/hzWn8wWFyff5WuAd/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Hacktron Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#060000\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.hacktron.ai/api-reference/scans/create-scan\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/scans/create-scan.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.hacktron.ai/#organization\",\"name\":\"Hacktron Docs\",\"url\":\"https://docs.hacktron.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/hacktronai/YwinZOi1ZhshTNrW/logo/light.svg?fit=max\u0026auto=format\u0026n=YwinZOi1ZhshTNrW\u0026q=85\u0026s=6394df2b0118979b4240f0a3d716cd43\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.hacktron.ai#website\",\"name\":\"Hacktron Docs\",\"url\":\"https://docs.hacktron.ai\",\"publisher\":{\"@id\":\"https://docs.hacktron.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.hacktron.ai/api-reference/scans/create-scan#webpage\",\"url\":\"https://docs.hacktron.ai/api-reference/scans/create-scan\",\"name\":\"Trigger a Whitebox Scan\",\"description\":\"Start a Whitebox Scan against one or more repositories.\",\"dateModified\":\"2026-07-22T05:45:22.560Z\",\"isPartOf\":{\"@id\":\"https://docs.hacktron.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.hacktron.ai/api-reference/scans/create-scan#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.hacktron.ai/api-reference/scans/create-scan#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Hacktron Docs\",\"item\":\"https://docs.hacktron.ai\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Trigger a Whitebox Scan\",\"item\":\"https://docs.hacktron.ai/api-reference/scans/create-scan\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.hacktron.ai/api-reference/scans/create-scan#apireference\",\"headline\":\"Trigger a Whitebox Scan\",\"name\":\"Trigger a Whitebox Scan\",\"description\":\"Start a Whitebox Scan against one or more repositories.\",\"url\":\"https://docs.hacktron.ai/api-reference/scans/create-scan\",\"mainEntityOfPage\":{\"@id\":\"https://docs.hacktron.ai/api-reference/scans/create-scan#webpage\"},\"dateModified\":\"2026-07-22T05:45:22.560Z\",\"publisher\":{\"@id\":\"https://docs.hacktron.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.hacktron.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Hacktron Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Hacktron Docs","nav":{"global":{"anchors":[{"anchor":"Code Review","icon":"code-branch","href":"/code-review/overview"},{"anchor":"White-box Pentest","icon":"magnifying-glass","href":"/white-box-pentest/overview"},{"anchor":"Community","icon":"discord","href":"https://discord.gg/eRHCHsvDKh"},{"anchor":"Changelog","icon":"clock-rotate-left","href":"/changelog"}]},"products":[{"product":"Platform","icon":"house","pages":[{"title":"Platform","href":""}]},{"product":"Code Review","icon":"code-branch","pages":[{"title":"Code Review","href":"/code-review/overview"}]},{"product":"White-box Pentest","icon":"magnifying-glass","pages":[{"title":"White-box Pentest","href":"/white-box-pentest/overview"}]},{"product":"API Reference","icon":"code","groups":[{"group":"Getting started","pages":[{"title":"Introduction","href":"/api-reference/introduction"},{"title":"Authentication","href":"/api-reference/authentication"},{"title":"Rate limits","href":"/api-reference/rate-limits"},{"title":"Pagination, filtering \u0026 sorting","href":"/api-reference/pagination-filtering"},{"title":"Errors","href":"/api-reference/errors"}]},{"group":"Cost Estimations","pages":[{"title":"Create cost estimation","openapi":"POST /cost-estimations","href":"/api-reference/cost-estimations/create-cost-estimation"},{"title":"List cost estimations","openapi":"GET /cost-estimations","href":"/api-reference/cost-estimations/list-cost-estimations"},{"title":"Get cost estimation","openapi":"GET /cost-estimations/{id}","description":"Fetch a cost estimation by ID.","href":"/api-reference/cost-estimations/get-cost-estimation"}]},{"group":"Scans","pages":[{"title":"Trigger a Whitebox Scan","openapi":"POST /scans","href":"/api-reference/scans/create-scan"},{"title":"List scans","openapi":"GET /scans","description":"List scans with pagination, filtering, and sorting.","href":"/api-reference/scans/list-scans"},{"title":"Get scan","openapi":"GET /scans/{id}","href":"/api-reference/scans/get-scan"},{"title":"Get scan status","openapi":"GET /scans/{id}/status","href":"/api-reference/scans/get-scan-status"},{"title":"List scan findings","openapi":"GET /scans/{id}/findings","href":"/api-reference/scans/list-scan-findings"},{"title":"Export scan findings","openapi":"GET /scans/{id}/findings/export","href":"/api-reference/scans/export-scan-findings"}]},{"group":"Findings","pages":[{"title":"List findings","openapi":"openapi.json GET /findings","href":"/api-reference/findings/list-findings"},{"title":"Get finding","openapi":"GET /findings/{id}","href":"/api-reference/findings/get-finding"},{"title":"Update finding","openapi":"PATCH /findings/{id}","href":"/api-reference/findings/update-finding"},{"title":"Add finding comment","openapi":"POST /findings/{id}/comments","href":"/api-reference/findings/add-finding-comment"},{"title":"Export findings","openapi":"openapi.json GET /findings/export","href":"/api-reference/findings/export-findings"}]},{"group":"Repositories","pages":[{"title":"List repositories","openapi":"openapi.json GET /repos","href":"/api-reference/repos/list-repos"}]},{"group":"Dependency Firewall","pages":[{"title":"Get package verdict","openapi":"openapi.json GET /hfw/verdict/{ecosystem}/{packageName}","href":"/api-reference/hfw/get-package-verdict"},{"title":"Get scoped npm package verdict","openapi":"openapi.json GET /hfw/verdict/{ecosystem}/{scope}/{packageName}","href":"/api-reference/hfw/get-scoped-npm-verdict"},{"title":"Get batch verdicts","openapi":"openapi.json POST /hfw/verdicts/batch","href":"/api-reference/hfw/batch-verdicts"},{"title":"List malware feed","openapi":"openapi.json GET /hfw/osv/feed","href":"/api-reference/hfw/osv-feed"}]}]},{"product":"MCP","icon":"plug","pages":[{"title":"MCP","href":"/mcp/get-started"}]},{"product":"Changelog","icon":"clock-rotate-left","pages":[{"title":"Changelog","href":"/changelog"}]}]},"title":"Trigger a Whitebox Scan - Hacktron Docs","buildId":"dpl_HcHmUS6i3UwswnTHJUEdcTtwfdTQ","deploymentId":"dpl_HcHmUS6i3UwswnTHJUEdcTtwfdTQ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-BRm_l__d.js","utils-f1l1Oc-G.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BlhqDhJO.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DHCB7rsC.js","snippetPresets-CYXLx6Hv.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-B78P2dEq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C4YLPVAh.js","shallow-vlLnTDkQ.js","getApiPlaygroundDisplay-D_98hhvf.js","CodeSnippet-DtnZHGqq.js","CodeSnippets-CLFb8KJt.js","Page-kQh739Uz.js","getPastedJson-Cq-zlbnU.js","icon-sN3t983t.js","MethodPill-P_YQ2s09.js","DuplicateIcon-BVzyNsGJ.js","createIcon-B3jqgqC6.js","DynamicMarkdown-Crwq6WG_.js","SectionHeading-C7pGS2Bb.js","axios-vUo_bRtp.js","Markdown-BuPH8yuW.js","clsx-CCOYKgaU.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BnkC_6oA.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BM4S31-f.js"]}