Creates a Self-check from an inline SourceSet supplied in this one request — files: [{path, content}] or a unified diff, no plan-folder / ingest / commit-ingest round trips. The server materializes a tmpdir and runs the same scanners, enrichments and policy engine a governed Scan runs.
A Self-check never materializes Findings, never touches the Project’s posture, and is purged after 30 days. It consumes credits exactly as a Scan does, because the same engines compute.
coverage is always partial: everything the submitted content allows to detect fires — a crypto call in a snippet, an OSS snippet match and the purls it enriches to, a manifest’s declared dependencies — while a policy the SourceSet cannot answer is reported in not_evaluated[] with a reason rather than passing silently.
The call is synchronous within a budget (default 45 s, organization-configurable). Past it the response is still 200, with status: running and the Self-check’s id; poll GET /v1/self-checks/{selfCheckId} with that id. Both shapes are the same SelfCheck resource, so a client never branches on two schemas.
An Earnie API key, sent as Authorization: Bearer sk_earnie_.... Create one under Settings > API keys. The key's scopes decide which operations it may call.
Body
application/json
Creates a Self-check from an INLINE SourceSet in one request — no plan-folder / ingest / commit-ingest round trips. The server materializes a tmpdir and runs the same pipeline.
Exactly one of files or diff must be present. There is no url or branch: the MCP surface never clones, and a run against a bound repository is a governed Scan through a Connection, not a Self-check.
The inline SourceSet. Limits are organization-configurable and start at 200 files, 512 KiB per file and 1 MiB per call. Over the limit is 422 source_set_too_large, which names the cap and the measured size so the caller can fall back to earnie scan diff.
A unified diff, as an alternative to files. Its post-image (the + side of every hunk) is materialized as the SourceSet, so a deletion-only diff yields no file to scan. Subject to the same byte caps as files.
Optional scanner set. Omitted runs every scanner enabled for the organization that the caller's API key scanner restriction allows; a disabled or out-of-scope scanner is rejected with 403.
Minimum array length: 1
A scanner phase selected for source-code scan compute. ai is AI provenance. A Self-check does not run it, and an explicit request for it on a Self-check answers 400 invalid_scanners.
Optional PURL enrichment list. Omitted defaults to ["vulnerabilities","licenses"]; an explicit empty array runs no optional enrichments.
Identifiers for optional PURL-driven enrichments. matching is the always-on core engine and is not an enrichment key. Dependency inventory is produced by the always-on dependency stage. Omitting enrichments defaults to ["vulnerabilities","licenses"].
Submission provenance. producer is resolved server-side as on every other creation path; a producer the actor cannot legitimately be is overwritten. This endpoint only ever creates a Self-check, so a resolved producer outside {pre_commit, mcp} is refused with 422 producer_not_self_check rather than silently downgraded.
How long the server may hold the request waiting for the run to reach a terminal state. Zero or omission uses the organization's configured budget (default 45 s — a pre-commit hook allows 60 s and an agent client's default tool timeout is around 60 s). Past the budget the response is 200 with status: running and the Self-check's id; the caller polls GET /v1/self-checks/{selfCheckId}.
Required range: 0 <= x <= 120
Response
The Self-check. status is completed/failed when the run finished within the budget, running when it did not.
A Self-check's lifecycle, collapsed from the underlying run's status. running covers every non-terminal state: the caller polls, or the creation call returned past its synchronous budget.
There is no cancelled here: a cancelled run reports failed. The receiving-idle sweep cancels a Self-check whose client stopped uploading, and running would never resolve.
The surface that submitted the scan (GLOSSARY "Producer"). Derived from the authenticated actor wherever the actor determines it; a client-declared value the actor cannot legitimately produce is overwritten server-side, never rejected.
pre_commit and mcp classify the run as a Self-check: it runs the same scanners, enrichments and policy engine and shows results, verdict and a deep link under the Project, but materializes no Findings, never touches posture, is held at partial coverage, is purged 30 days after creation and leaves a selfcheck.* decision log instead of finding.detected.
A Self-check is read through /v1/self-checks, not /v1/scans: the Scan endpoints return governed Scans only.
The identity that submitted the scan. Replaces the former plain created_by user uuid: a scan may be submitted by an API key, a provider Connection or an internal worker, none of which is a user.
When the retention sweep purges this Self-check — 30 days after creation. The selfcheck.* decision log outlives it: audit retention is the general one.
The inline SourceSet boundary decided by the shared keep plan, before scanner-specific progress counters run. Manifests count as included because dependency detection evaluates them even when OSS fingerprinting does not.
The Self-check's collapsed policy outcome. Same vocabulary and same precedence as a Scan's gate — error > block > require > warn > pass, with none the distinct non-enforcing result when no policy applied. Null while status is running.
Scanner progress count retained for compatibility. Use files for the submitted/included/excluded SourceSet boundary; this value may exclude manifests consumed by dependency detection.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"SCANOSS documentation","colors":{"primary":"#FF6A1A","light":"#FF6A1A","dark":"#FF6A1A"},"logo":{"light":"https://mintcdn.com/scanoss/9UP7eHL2Z_rQPx8l/scanoss-logo-horizontal-positive.svg?fit=max\u0026auto=format\u0026n=9UP7eHL2Z_rQPx8l\u0026q=85\u0026s=686c4487013423ef804e2e83983c76ef","dark":"https://mintcdn.com/scanoss/9UP7eHL2Z_rQPx8l/scanoss-logo-horizontal-negative.svg?fit=max\u0026auto=format\u0026n=9UP7eHL2Z_rQPx8l\u0026q=85\u0026s=03cf2002f3fff2726f8e9b19bb2781ec","href":"https://scanoss.com"},"favicon":"https://mintcdn.com/scanoss/SuvZQ2xWfRUv4OAb/scan-favicon.png?fit=max\u0026auto=format\u0026n=SuvZQ2xWfRUv4OAb\u0026q=85\u0026s=4f02839460dfdc66102d3b028b507df6","appearance":{"default":"system","strict":false},"footer":{"socials":{"x":"https://x.com/SCANOSS_","github":"https://github.com/scanoss","linkedin":"https://es.linkedin.com/company/scanoss"}},"seo":{"indexing":"all"},"fonts":{"heading":{"family":"Space Grotesk","weight":700,"format":"woff2"},"body":{"family":"Space Grotesk","format":"woff2"}},"integrations":{"ga4":{"measurementId":"G-NWY31TXG8Y"}},"banner":{"content":"**Earnie is here** — SCANOSS's major release for AI governance, cryptography, PQC readiness, and open source compliance. [Watch the release demo →](https://youtu.be/MKgIpH4bEQ4?si=wXECS3umWGx11mB7)","dismissible":true},"contextual":{"options":["copy","view","claude","chatgpt","cursor","vscode","mcp"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"scanoss","hasAudioNarration":false,"actualSubdomain":"scanoss","customDomains":["docs.scanoss.com"],"gitSource":{"type":"github","owner":"scanoss","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af4de431c57d74f3a12ae72","clientVersion":"0.0.4111","searchFilterCounts":[{"language":"default","tag":"Earnie","count":163},{"language":"default","tag":"API Reference","count":137},{"language":"default","tag":"Guides","count":84},{"language":"default","tag":"Developer Tools","count":67},{"language":"default","tag":"API reference","count":48},{"language":"default","tag":"v3 endpoints","count":47},{"language":"default","tag":"Scans","count":44},{"language":"default","tag":"scans","count":44},{"language":"default","tag":"Policies","count":22},{"language":"default","tag":"Findings","count":21}]},"assistantConfig":{"enableStarterQuestions":true,"deflection":{"enabled":true,"email":"support@scanoss.com","showHelpButton":true}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","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":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","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":"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":"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":"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":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","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":"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":"workos-sso-scim","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},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"starterQuestions":[{"_id":"695fa5b6a879c7d6b0e8a169","deploymentId":"68551e34bde804c6773f4df2","questionText":"Cannot import/export projects?","status":"active","generatedBy":"manual","createdAt":"2026-01-08T12:40:22.697Z","updatedAt":"2026-01-08T12:40:22.697Z","__v":0},{"_id":"695fa5a4a879c7d6b0e8a064","deploymentId":"68551e34bde804c6773f4df2","questionText":"Dependency files not detected during scan?","status":"active","generatedBy":"manual","createdAt":"2026-01-08T12:40:04.675Z","updatedAt":"2026-01-08T12:40:04.675Z","__v":0},{"_id":"695fa566a879c7d6b0e89d1e","deploymentId":"68551e34bde804c6773f4df2","questionText":"How do I configure the SCANOSS API key?","status":"active","generatedBy":"manual","createdAt":"2026-01-08T12:39:02.662Z","updatedAt":"2026-01-08T12:39:02.662Z","__v":0}],"googleFontsInlined":true},"customCss":[{"filePath":"style.css","content":"#banner{background-color:#ff6a1a!important;color:#ffffff!important}html:not(.dark) #background-color,html:not(.dark) #navbar-transition{background-color:#f4f6f9!important}html:not(.dark) h1{color:#081320!important}html:not(.dark) nav a[aria-current=\"page\"]{background-color:rgba(8, 19, 32, 0.1)!important}html:not(.dark) .chat-assistant-floating-input .bg-background-light,html:not(.dark) .chat-assistant-floating-input::before,html:not(.dark) #assistant-entry,html:not(.dark) #chat-assistant-sheet,html:not(.dark) #chat-assistant-sheet .bg-background-light{background-color:#f4f6f9!important}html.dark #background-color,html.dark #navbar-transition{background-color:#081320!important}html.dark h1,html.dark .prose :where(h1,h2,h3,h4,h5,h6),html.dark .prose :where(p,li,td,th):not(svg *){color:#ffffff!important}html.dark nav a[aria-current=\"page\"]{background-color:rgba(255, 106, 26, 0.15)!important}html.dark .chat-assistant-floating-input .dark\\:bg-background-dark,html.dark .chat-assistant-floating-input::before,html.dark #assistant-entry,html.dark #chat-assistant-sheet,html.dark #chat-assistant-sheet .dark\\:bg-background-dark{background-color:#081320!important}span[style*=\"radial-gradient\"]{display:none!important}nav#sidebar .sticky.top-0.h-8{display:none!important}#sidebar #navigation-items{padding-top:2rem}.eyebrow{color:#ff6a1a!important}nav a.text-primary{color:#ff6a1a!important}"}],"page":{"pagePath":"earnie/api-reference/scans/scans/run-a-self-check-over-an-inline-sourceset","slug":"/earnie/api-reference/scans/scans/run-a-self-check-over-an-inline-sourceset","pageMetadata":{"title":"Run a Self-check over an inline SourceSet","description":"Creates a Self-check from an inline SourceSet supplied in this one request — `files: [{path, content}]` or a unified `diff`, no plan-folder / ingest / commit-ingest round trips. The server materializes a tmpdir and runs the same scanners, enrichments and policy engine a governed Scan runs.\n\nA Self-check never materializes Findings, never touches the Project's posture, and is purged after 30 days. It consumes credits exactly as a Scan does, because the same engines compute.\n\n`coverage` is always `partial`: everything the submitted content allows to detect fires — a crypto call in a snippet, an OSS snippet match and the purls it enriches to, a manifest's declared dependencies — while a policy the SourceSet cannot answer is reported in `not_evaluated[]` with a reason rather than passing silently.\n\nThe call is synchronous within a budget (default 45 s, organization-configurable). Past it the response is still `200`, with `status: running` and the Self-check's `id`; poll `GET /v1/self-checks/{selfCheckId}` with that id. Both shapes are the same `SelfCheck` resource, so a client never branches on two schemas.","deprecated":null,"version":null,"openapi":"/api-reference/earnie/scans-openapi.json post /v1/self-checks","href":"/earnie/api-reference/scans/scans/run-a-self-check-over-an-inline-sourceset","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsxs(_components.p, {\n children: [\"Creates a Self-check from an inline SourceSet supplied in this one request — \", _jsx(_components.code, {\n children: \"files: [{path, content}]\"\n }), \" or a unified \", _jsx(_components.code, {\n children: \"diff\"\n }), \", no plan-folder / ingest / commit-ingest round trips. The server materializes a tmpdir and runs the same scanners, enrichments and policy engine a governed Scan runs.\"]\n }), \"\\n\", _jsx(_components.p, {\n children: \"A Self-check never materializes Findings, never touches the Project’s posture, and is purged after 30 days. It consumes credits exactly as a Scan does, because the same engines compute.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.code, {\n children: \"coverage\"\n }), \" is always \", _jsx(_components.code, {\n children: \"partial\"\n }), \": everything the submitted content allows to detect fires — a crypto call in a snippet, an OSS snippet match and the purls it enriches to, a manifest’s declared dependencies — while a policy the SourceSet cannot answer is reported in \", _jsx(_components.code, {\n children: \"not_evaluated[]\"\n }), \" with a reason rather than passing silently.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"The call is synchronous within a budget (default 45 s, organization-configurable). Past it the response is still \", _jsx(_components.code, {\n children: \"200\"\n }), \", with \", _jsx(_components.code, {\n children: \"status: running\"\n }), \" and the Self-check’s \", _jsx(_components.code, {\n children: \"id\"\n }), \"; poll \", _jsx(_components.code, {\n children: \"GET /v1/self-checks/{selfCheckId}\"\n }), \" with that id. Both shapes are the same \", _jsx(_components.code, {\n children: \"SelfCheck\"\n }), \" resource, so a client never branches on two schemas.\"]\n })]\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}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Run a Self-check over an inline SourceSet","description":"Creates a Self-check from an inline SourceSet supplied in this one request — `files: [{path, content}]` or a unified `diff`, no plan-folder / ingest / commit-ingest round trips. The server materializes a tmpdir and runs the same scanners, enrichments and policy engine a governed Scan runs.\n\nA Self-check never materializes Findings, never touches the Project's posture, and is purged after 30 days. It consumes credits exactly as a Scan does, because the same engines compute.\n\n`coverage` is always `partial`: everything the submitted content allows to detect fires — a crypto call in a snippet, an OSS snippet match and the purls it enriches to, a manifest's declared dependencies — while a policy the SourceSet cannot answer is reported in `not_evaluated[]` with a reason rather than passing silently.\n\nThe call is synchronous within a budget (default 45 s, organization-configurable). Past it the response is still `200`, with `status: running` and the Self-check's `id`; poll `GET /v1/self-checks/{selfCheckId}` with that id. Both shapes are the same `SelfCheck` resource, so a client never branches on two schemas.","deprecated":null,"version":null,"openapi":"/api-reference/earnie/scans-openapi.json post /v1/self-checks","href":"/earnie/api-reference/scans/scans/run-a-self-check-over-an-inline-sourceset","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"PostV1SelfChecks","summary":"Run a Self-check over an inline SourceSet","description":"Creates a Self-check from an inline SourceSet supplied in this one request — `files: [{path, content}]` or a unified `diff`, no plan-folder / ingest / commit-ingest round trips. The server materializes a tmpdir and runs the same scanners, enrichments and policy engine a governed Scan runs.\n\nA Self-check never materializes Findings, never touches the Project's posture, and is purged after 30 days. It consumes credits exactly as a Scan does, because the same engines compute.\n\n`coverage` is always `partial`: everything the submitted content allows to detect fires — a crypto call in a snippet, an OSS snippet match and the purls it enriches to, a manifest's declared dependencies — while a policy the SourceSet cannot answer is reported in `not_evaluated[]` with a reason rather than passing silently.\n\nThe call is synchronous within a budget (default 45 s, organization-configurable). Past it the response is still `200`, with `status: running` and the Self-check's `id`; poll `GET /v1/self-checks/{selfCheckId}` with that id. Both shapes are the same `SelfCheck` resource, so a client never branches on two schemas.","tags":["scans"],"requestBody":"5c8433f0-1b7c-473d-b299-c605dc751072","responses":{"200":"afa0fe14-403c-4609-97fd-67589fbe32bc","400":"0bb11d78-fd73-460a-b3f0-50a710a226c4","401":"b7289f47-e731-420b-b483-0f9b8da61588","403":"cb819dd6-26e0-4acd-b203-57b8f4c9309b","422":"8eb178b7-ca62-4874-a9a2-fcb782f1fc4a"},"method":"post","type":"path","servers":["78824d01-63cc-41fd-9d19-c3590c2af6c2"],"security":["044b1aa4-bef2-430b-bd04-5a8e9add18c6"],"path":"/v1/self-checks","baseUrlOptions":["https://{tenant}.earnie.dev"],"title":"Run a Self-check over an inline SourceSet","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"Creates a Self-check from an INLINE SourceSet in one request — no plan-folder / ingest / commit-ingest round trips. The server materializes a tmpdir and runs the same pipeline.\n\nExactly one of `files` or `diff` must be present. There is no `url` or `branch`: the MCP surface never clones, and a run against a bound repository is a governed Scan through a Connection, not a Self-check.","required":["project_id"],"properties":{"project_id":{"type":"string","format":"uuid","description":"The project the submitted code belongs to.","isRequired":true,"uniqueKey":"project_id","typeLabel":"string\u003cuuid>"},"files":{"type":"array","description":"The inline SourceSet. Limits are organization-configurable and start at 200 files, 512 KiB per file and 1 MiB per call. Over the limit is `422 source_set_too_large`, which names the cap and the measured size so the caller can fall back to `earnie scan diff`.","items":{"type":"object","description":"One file of an inline SourceSet. `content` is UTF-8 text; a binary payload is rejected rather than scanned, because neither the OSS snippet matcher nor crypto-finder can read one from an inline submission.","required":["path","content"],"properties":{"path":{"type":"string","description":"Repository-relative path. Absolute paths and `..` segments are rejected.","isRequired":true,"uniqueKey":"files.items.[INDEX].path","typeLabel":"string"},"content":{"type":"string","description":"UTF-8 file content.","isRequired":true,"uniqueKey":"files.items.[INDEX].content","typeLabel":"string"}},"uniqueKey":"files.items.[INDEX]","typeLabel":"object"},"uniqueKey":"files","typeLabel":"object[]"},"diff":{"type":"string","description":"A unified diff, as an alternative to `files`. Its post-image (the `+` side of every hunk) is materialized as the SourceSet, so a deletion-only diff yields no file to scan. Subject to the same byte caps as `files`.","uniqueKey":"diff","typeLabel":"string"},"name":{"type":"string","description":"Optional display name. Defaults to a generated label.","uniqueKey":"name","typeLabel":"string"},"scanners":{"type":"array","minItems":1,"items":{"type":"string","enum":["oss","crypto","ai"],"description":"A scanner phase selected for source-code scan compute. `ai` is AI provenance. A Self-check does not run it, and an explicit request for it on a Self-check answers 400 `invalid_scanners`.","uniqueKey":"scanners.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"Optional scanner set. Omitted runs every scanner enabled for the organization that the caller's API key scanner restriction allows; a disabled or out-of-scope scanner is rejected with 403.","uniqueKey":"scanners","typeLabel":"enum\u003cstring>[]"},"enrichments":{"type":"array","items":{"type":"string","enum":["vulnerabilities","licenses"],"description":"Identifiers for optional PURL-driven enrichments. `matching` is the always-on core engine and is not an enrichment key. Dependency inventory is produced by the always-on dependency stage. Omitting `enrichments` defaults to [\"vulnerabilities\",\"licenses\"].","uniqueKey":"enrichments.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"Optional PURL enrichment list. Omitted defaults to [\"vulnerabilities\",\"licenses\"]; an explicit empty array runs no optional enrichments.","uniqueKey":"enrichments","typeLabel":"enum\u003cstring>[]"},"scan_context":{"oneOf":[{"type":"object","description":"Submission provenance. `producer` is resolved server-side as on every other creation path; a producer the actor cannot legitimately be is overwritten. This endpoint only ever creates a Self-check, so a resolved producer outside {`pre_commit`, `mcp`} is refused with `422 producer_not_self_check` rather than silently downgraded.","properties":{"producer":{"type":"string","enum":["ui_upload","connected_repo","pr_ci","cli","pre_commit","mcp","sbom_import"],"description":"The surface that submitted the scan (GLOSSARY \"Producer\"). Derived from the authenticated actor wherever the actor determines it; a client-declared value the actor cannot legitimately produce is overwritten server-side, never rejected.\n\n`pre_commit` and `mcp` classify the run as a Self-check: it runs the same scanners, enrichments and policy engine and shows results, verdict and a deep link under the Project, but materializes no Findings, never touches posture, is held at `partial` coverage, is purged 30 days after creation and leaves a `selfcheck.*` decision log instead of `finding.detected`.\n\nA Self-check is read through `/v1/self-checks`, not `/v1/scans`: the Scan endpoints return governed Scans only.","uniqueKey":"scan_context.oneOf.0.producer","typeLabel":"enum\u003cstring>"},"coverage":{"type":"string","description":"The coverage the client intends. The server validates it: a downgrade to `partial` is honoured, a promotion to `full` is rejected with `coverage_promotion_rejected`.","enum":["full","partial"],"uniqueKey":"scan_context.oneOf.0.coverage","typeLabel":"enum\u003cstring>"},"provider":{"oneOf":[{"type":"string","description":"The source-code provider the submission originated from, such as github or gitlab. Any connected provider's name.","pattern":"^[a-z][a-z0-9-]{0,31}$","uniqueKey":"scan_context.oneOf.0.provider.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"scan_context.oneOf.0.provider.oneOf.1","typeLabel":"null"}],"uniqueKey":"scan_context.oneOf.0.provider","typeLabel":"string | null"},"repository":{"oneOf":[{"type":"object","description":"The provider repository the submitted code belongs to.","required":["external_id","full_name"],"properties":{"external_id":{"type":"string","description":"The provider's immutable repository id (GitHub's numeric repo id, GitLab's project id) as a string. Survives rename and transfer.","isRequired":true,"uniqueKey":"scan_context.oneOf.0.repository.oneOf.0.external_id","typeLabel":"string"},"full_name":{"type":"string","description":"Display path in `owner/name` form. Mutable — never a match key.","isRequired":true,"uniqueKey":"scan_context.oneOf.0.repository.oneOf.0.full_name","typeLabel":"string"}},"uniqueKey":"scan_context.oneOf.0.repository.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"scan_context.oneOf.0.repository.oneOf.1","typeLabel":"null"}],"uniqueKey":"scan_context.oneOf.0.repository","typeLabel":"object | null"},"change_request":{"oneOf":[{"type":"object","description":"The pull/merge request the submission belongs to. An *identified* one makes the scan `partial` — at least one of `number`, `url`, `base_sha`, `head_sha` or `head_ref` must be set for it to count. An empty object narrows nothing, because a client that had been silently narrowed could not ask for `full` again without deleting the provenance it wanted.\n\nNote this applies to a `git` submission too, not only a diff upload. A pipeline that wants full-coverage posture submits without change-request provenance.","properties":{"number":{"type":"integer","description":"Provider-visible PR/MR number.","uniqueKey":"scan_context.oneOf.0.change_request.oneOf.0.number","typeLabel":"integer"},"url":{"type":"string","description":"Deep link back to the change request.","uniqueKey":"scan_context.oneOf.0.change_request.oneOf.0.url","typeLabel":"string"},"base_sha":{"type":"string","description":"The commit the change request is based on.","uniqueKey":"scan_context.oneOf.0.change_request.oneOf.0.base_sha","typeLabel":"string"},"head_sha":{"type":"string","description":"The commit the submitted code was taken at.","uniqueKey":"scan_context.oneOf.0.change_request.oneOf.0.head_sha","typeLabel":"string"},"base_ref":{"type":"string","description":"The branch the change request targets.","uniqueKey":"scan_context.oneOf.0.change_request.oneOf.0.base_ref","typeLabel":"string"},"head_ref":{"type":"string","description":"The change request's source branch.","uniqueKey":"scan_context.oneOf.0.change_request.oneOf.0.head_ref","typeLabel":"string"}},"uniqueKey":"scan_context.oneOf.0.change_request.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"scan_context.oneOf.0.change_request.oneOf.1","typeLabel":"null"}],"uniqueKey":"scan_context.oneOf.0.change_request","typeLabel":"object | null"},"commit_sha":{"oneOf":[{"type":"string","uniqueKey":"scan_context.oneOf.0.commit_sha.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"scan_context.oneOf.0.commit_sha.oneOf.1","typeLabel":"null"}],"uniqueKey":"scan_context.oneOf.0.commit_sha","typeLabel":"string | null"},"branch":{"oneOf":[{"type":"string","uniqueKey":"scan_context.oneOf.0.branch.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"scan_context.oneOf.0.branch.oneOf.1","typeLabel":"null"}],"uniqueKey":"scan_context.oneOf.0.branch","typeLabel":"string | null"},"run":{"oneOf":[{"type":"object","description":"The CI job that submitted the scan — a link back, never a match key.","properties":{"ci_system":{"type":"string","description":"e.g. `github_actions`, `gitlab_ci`, `jenkins`.","uniqueKey":"scan_context.oneOf.0.run.oneOf.0.ci_system","typeLabel":"string"},"url":{"type":"string","description":"Deep link to the CI run.","uniqueKey":"scan_context.oneOf.0.run.oneOf.0.url","typeLabel":"string"},"external_id":{"type":"string","description":"The CI system's own run identifier.","uniqueKey":"scan_context.oneOf.0.run.oneOf.0.external_id","typeLabel":"string"}},"uniqueKey":"scan_context.oneOf.0.run.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"scan_context.oneOf.0.run.oneOf.1","typeLabel":"null"}],"uniqueKey":"scan_context.oneOf.0.run","typeLabel":"object | null"}},"uniqueKey":"scan_context.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"scan_context.oneOf.1","typeLabel":"null"}],"uniqueKey":"scan_context","typeLabel":"object | null"},"wait_seconds":{"type":"integer","minimum":0,"maximum":120,"description":"How long the server may hold the request waiting for the run to reach a terminal state. Zero or omission uses the organization's configured budget (default 45 s — a pre-commit hook allows 60 s and an agent client's default tool timeout is around 60 s). Past the budget the response is `200` with `status: running` and the Self-check's `id`; the caller polls `GET /v1/self-checks/{selfCheckId}`.","uniqueKey":"wait_seconds","typeLabel":"integer"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"project_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","files":[{"path":"\u003cstring>","content":"\u003cstring>"}],"diff":"\u003cstring>","name":"\u003cstring>","scanners":[],"enrichments":[],"scan_context":{"provider":"\u003cstring>","repository":{"external_id":"\u003cstring>","full_name":"\u003cstring>"},"change_request":{"number":123,"url":"\u003cstring>","base_sha":"\u003cstring>","head_sha":"\u003cstring>","base_ref":"\u003cstring>","head_ref":"\u003cstring>"},"commit_sha":"\u003cstring>","branch":"\u003cstring>","run":{"ci_system":"\u003cstring>","url":"\u003cstring>","external_id":"\u003cstring>"}},"wait_seconds":60}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"afa0fe14-403c-4609-97fd-67589fbe32bc":{"description":"The Self-check. `status` is `completed`/`failed` when the run finished within the budget, `running` when it did not.","content":{"application/json":{"schema":{"type":"object","description":"A Self-check.","required":["id","project_id","project","status","coverage","producer","created_by","created_at","expires_at","files","scanners","evaluated","not_evaluated","violations","url"],"properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"id","typeLabel":"string\u003cuuid>"},"project_id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"project_id","typeLabel":"string\u003cuuid>"},"project":{"type":"object","description":"Light reference to a linked project (denormalised for list rendering).","required":["id","slug","name"],"properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"project.id","typeLabel":"string\u003cuuid>"},"slug":{"type":"string","isRequired":true,"uniqueKey":"project.slug","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"project.name","typeLabel":"string"}},"isRequired":true,"uniqueKey":"project","typeLabel":"object"},"status":{"type":"string","enum":["running","completed","failed"],"description":"A Self-check's lifecycle, collapsed from the underlying run's status. `running` covers every non-terminal state: the caller polls, or the creation call returned past its synchronous budget.\n\nThere is no `cancelled` here: a cancelled run reports `failed`. The receiving-idle sweep cancels a Self-check whose client stopped uploading, and `running` would never resolve.","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"coverage":{"type":"string","description":"Always `partial`. An inline SourceSet is a subset of a codebase and a Self-check may never mark a Project's findings absent.","enum":["full","partial"],"isRequired":true,"uniqueKey":"coverage","typeLabel":"enum\u003cstring>"},"producer":{"type":"string","enum":["ui_upload","connected_repo","pr_ci","cli","pre_commit","mcp","sbom_import"],"description":"The surface that submitted the scan (GLOSSARY \"Producer\"). Derived from the authenticated actor wherever the actor determines it; a client-declared value the actor cannot legitimately produce is overwritten server-side, never rejected.\n\n`pre_commit` and `mcp` classify the run as a Self-check: it runs the same scanners, enrichments and policy engine and shows results, verdict and a deep link under the Project, but materializes no Findings, never touches posture, is held at `partial` coverage, is purged 30 days after creation and leaves a `selfcheck.*` decision log instead of `finding.detected`.\n\nA Self-check is read through `/v1/self-checks`, not `/v1/scans`: the Scan endpoints return governed Scans only.","isRequired":true,"uniqueKey":"producer","typeLabel":"enum\u003cstring>"},"created_by":{"type":"object","description":"The identity that submitted the scan. Replaces the former plain `created_by` user uuid: a scan may be submitted by an API key, a provider Connection or an internal worker, none of which is a user.","required":["kind","id"],"properties":{"kind":{"type":"string","enum":["user","api_key","integration","worker"],"description":"The kind of identity that submitted the scan. `integration` is a provider Connection (a GitHub App installation); `worker` is an internal job such as the reconcile sweep.","isRequired":true,"uniqueKey":"created_by.kind","typeLabel":"enum\u003cstring>"},"id":{"type":"string","format":"uuid","description":"The actor's row id — a user id, an API-key id, a Connection id or the internal job id, per `kind`. Not a foreign key to `users`.","isRequired":true,"uniqueKey":"created_by.id","typeLabel":"string\u003cuuid>"}},"isRequired":true,"uniqueKey":"created_by","typeLabel":"object"},"created_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"expires_at":{"type":"string","format":"date-time","description":"When the retention sweep purges this Self-check — 30 days after creation. The `selfcheck.*` decision log outlives it: audit retention is the general one.","isRequired":true,"uniqueKey":"expires_at","typeLabel":"string\u003cdate-time>"},"files":{"type":"object","description":"The inline SourceSet boundary decided by the shared keep plan, before scanner-specific progress counters run. Manifests count as included because dependency detection evaluates them even when OSS fingerprinting does not.","required":["submitted","included","excluded","preexisting_modified"],"properties":{"submitted":{"type":"integer","minimum":0,"isRequired":true,"uniqueKey":"files.submitted","typeLabel":"integer"},"included":{"type":"integer","minimum":0,"isRequired":true,"uniqueKey":"files.included","typeLabel":"integer"},"excluded":{"type":"integer","minimum":0,"description":"Files excluded by Scan Configuration. A non-zero value means the gate does not cover every submitted file.","isRequired":true,"uniqueKey":"files.excluded","typeLabel":"integer"},"preexisting_modified":{"type":"array","description":"Repository-relative paths that were already modified before the agent turn and were touched again during that turn.","items":{"type":"string","uniqueKey":"files.preexisting_modified.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"files.preexisting_modified","typeLabel":"string[]"}},"isRequired":true,"uniqueKey":"files","typeLabel":"object"},"scanners":{"type":"array","description":"Every scanner Earnie knows, with whether this run executed it. Empty until the submission is resolved; complete from the first response on.","items":{"type":"object","description":"One scanner Earnie knows, and whether this Self-check ran it. Every known scanner is listed, so a reader can tell \"ai found nothing\" from \"ai never looked\". A policy whose scanner did not run is reported in `not_evaluated` with reason `scanner_not_run`, never as passed.","required":["scanner","ran"],"properties":{"scanner":{"type":"string","enum":["oss","crypto","ai"],"isRequired":true,"uniqueKey":"scanners.items.[INDEX].scanner","typeLabel":"enum\u003cstring>"},"ran":{"type":"boolean","isRequired":true,"uniqueKey":"scanners.items.[INDEX].ran","typeLabel":"boolean"},"reason":{"type":"string","enum":["not_enabled","not_in_key_scope","not_requested","unavailable"],"description":"Why the scanner did not run; absent when `ran` is true. `not_enabled` — the organization has not enabled the scanner; `not_in_key_scope` — the API key's scanner restriction excludes it; `not_requested` — the caller's `scanners` list left it out; `unavailable` — this deployment cannot run it.","uniqueKey":"scanners.items.[INDEX].reason","typeLabel":"enum\u003cstring>"}},"uniqueKey":"scanners.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"scanners","typeLabel":"object[]"},"evaluated":{"type":"object","description":"How much the Self-check actually evaluated.","required":["policies","detections"],"properties":{"policies":{"type":"integer","description":"Policies in the snapshot that produced a verdict.","isRequired":true,"uniqueKey":"evaluated.policies","typeLabel":"integer"},"detections":{"type":"integer","description":"Detections the policy engine was given.","isRequired":true,"uniqueKey":"evaluated.detections","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"evaluated","typeLabel":"object"},"not_evaluated":{"type":"array","items":{"type":"object","description":"One policy in the snapshot that produced no verdict, and why. Missing enrichment or an evaluation failure makes the collapsed gate `error`; `not_applicable` remains reported without inventing a verdict for a repository-wide question a partial SourceSet cannot answer.","required":["policy","reason"],"properties":{"policy":{"type":"object","description":"The policy a violation or a `not_evaluated` entry is about, named at the revision the Self-check's policy snapshot captured.","required":["id","name","revision"],"properties":{"id":{"type":"integer","format":"int64","isRequired":true,"uniqueKey":"not_evaluated.items.[INDEX].policy.id","typeLabel":"integer\u003cint64>"},"name":{"type":"string","isRequired":true,"uniqueKey":"not_evaluated.items.[INDEX].policy.name","typeLabel":"string"},"revision":{"type":"string","description":"The policy's content hash (`sha256:\u003chex>`).","isRequired":true,"uniqueKey":"not_evaluated.items.[INDEX].policy.revision","typeLabel":"string"}},"isRequired":true,"uniqueKey":"not_evaluated.items.[INDEX].policy","typeLabel":"object"},"reason":{"type":"string","description":"Machine-readable cause. `enrichment_missing` — the policy needs an enrichment this run did not complete; `evaluation_error` — the expression could not be evaluated; `not_applicable` — no finding in the SourceSet carried the inputs the policy reads; `scanner_not_run` — the scanner that produces this policy's findings did not run (see `scanners` for why), so the policy could not observe anything.","isRequired":true,"uniqueKey":"not_evaluated.items.[INDEX].reason","typeLabel":"string"},"detail":{"type":"string","description":"Human-readable explanation, safe to show to a developer.","uniqueKey":"not_evaluated.items.[INDEX].detail","typeLabel":"string"}},"uniqueKey":"not_evaluated.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"not_evaluated","typeLabel":"object[]"},"violations":{"type":"array","items":{"type":"object","description":"One policy the Self-check's detections violated.","required":["policy","verdict","findings"],"properties":{"policy":{"type":"object","description":"The policy a violation or a `not_evaluated` entry is about, named at the revision the Self-check's policy snapshot captured.","required":["id","name","revision"],"properties":{"id":{"type":"integer","format":"int64","isRequired":true,"uniqueKey":"violations.items.[INDEX].policy.id","typeLabel":"integer\u003cint64>"},"name":{"type":"string","isRequired":true,"uniqueKey":"violations.items.[INDEX].policy.name","typeLabel":"string"},"revision":{"type":"string","description":"The policy's content hash (`sha256:\u003chex>`).","isRequired":true,"uniqueKey":"violations.items.[INDEX].policy.revision","typeLabel":"string"}},"isRequired":true,"uniqueKey":"violations.items.[INDEX].policy","typeLabel":"object"},"verdict":{"type":"string","enum":["block","warn","require","error"],"description":"The policy's action as produced by evaluation. `pass` never appears here — a policy that passed is not a violation.","isRequired":true,"uniqueKey":"violations.items.[INDEX].verdict","typeLabel":"enum\u003cstring>"},"findings":{"type":"array","items":{"type":"object","description":"One detection that made a policy fire. It is NOT a Finding: a Self-check materializes none. The reference lives only for the Self-check's retention window.","required":["path","kind","summary"],"properties":{"path":{"type":"string","description":"The SourceSet path the detection was made in.","isRequired":true,"uniqueKey":"violations.items.[INDEX].findings.items.[INDEX].path","typeLabel":"string"},"kind":{"type":"string","description":"The detection's finding domain, emitted verbatim. `deps` identifies a manifest-declared dependency; `oss` identifies a code match.","isRequired":true,"uniqueKey":"violations.items.[INDEX].findings.items.[INDEX].kind","typeLabel":"string"},"summary":{"type":"string","description":"One-line description of what was detected.","isRequired":true,"uniqueKey":"violations.items.[INDEX].findings.items.[INDEX].summary","typeLabel":"string"},"line":{"oneOf":[{"type":"integer","description":"1-based line, when the producer reported one.","uniqueKey":"violations.items.[INDEX].findings.items.[INDEX].line.oneOf.0","typeLabel":"integer"},{"type":"null","description":"1-based line, when the producer reported one.","uniqueKey":"violations.items.[INDEX].findings.items.[INDEX].line.oneOf.1","typeLabel":"null"}],"uniqueKey":"violations.items.[INDEX].findings.items.[INDEX].line","typeLabel":"integer | null"},"evidence_ref":{"type":"string","description":"Opaque, stable-within-this-Self-check identity for the detection, so a caller can correlate two entries that name the same evidence.","uniqueKey":"violations.items.[INDEX].findings.items.[INDEX].evidence_ref","typeLabel":"string"}},"uniqueKey":"violations.items.[INDEX].findings.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"violations.items.[INDEX].findings","typeLabel":"object[]"},"remediation":{"oneOf":[{"type":"object","description":"Tiered fix guidance for a violation (GLOSSARY \"Remediation advice\"). Only tier `B` — direction derived from the failed condition — is produced today; tiers `A` (deterministic fix), `A_prime` (AI-suggested, labelled) and `C` (request a Policy Approval) arrive with the remediation tickets. `prompt` is the copyable agent instruction, and is the same text published on PRs.","required":["tier","summary","prompt"],"properties":{"tier":{"type":"string","enum":["A","A_prime","B","C"],"isRequired":true,"uniqueKey":"violations.items.[INDEX].remediation.oneOf.0.tier","typeLabel":"enum\u003cstring>"},"summary":{"type":"string","isRequired":true,"uniqueKey":"violations.items.[INDEX].remediation.oneOf.0.summary","typeLabel":"string"},"prompt":{"type":"string","isRequired":true,"uniqueKey":"violations.items.[INDEX].remediation.oneOf.0.prompt","typeLabel":"string"}},"uniqueKey":"violations.items.[INDEX].remediation.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"violations.items.[INDEX].remediation.oneOf.1","typeLabel":"null"}],"uniqueKey":"violations.items.[INDEX].remediation","typeLabel":"object | null"}},"uniqueKey":"violations.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"violations","typeLabel":"object[]"},"url":{"type":"string","description":"Deep link to the Self-check under its Project.","isRequired":true,"uniqueKey":"url","typeLabel":"string"},"name":{"type":"string","uniqueKey":"name","typeLabel":"string"},"gate":{"oneOf":[{"type":"string","description":"The Self-check's collapsed policy outcome. Same vocabulary and same precedence as a Scan's gate — `error > block > require > warn > pass`, with `none` the distinct non-enforcing result when no policy applied. Null while `status` is `running`.","enum":["pass","warn","block","require","error","none"],"uniqueKey":"gate.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"gate.oneOf.1","typeLabel":"null"}],"uniqueKey":"gate","typeLabel":"enum\u003cstring> | null"},"finished_at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"finished_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"finished_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"finished_at","typeLabel":"string\u003cdate-time> | null"},"files_total":{"type":"integer","deprecated":true,"description":"Scanner progress count retained for compatibility. Use `files` for the submitted/included/excluded SourceSet boundary; this value may exclude manifests consumed by dependency detection.","uniqueKey":"files_total","typeLabel":"integer"},"error_code":{"oneOf":[{"type":"string","uniqueKey":"error_code.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"error_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"error_code","typeLabel":"string | null"},"error_message":{"oneOf":[{"type":"string","uniqueKey":"error_message.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"error_message.oneOf.1","typeLabel":"null"}],"uniqueKey":"error_message","typeLabel":"string | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","project_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","project":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","slug":"\u003cstring>","name":"\u003cstring>"},"status":"running","coverage":"full","producer":"ui_upload","created_by":{"kind":"user","id":"3c90c3cc-0d44-4b50-8888-8dd25736052a"},"created_at":"2023-11-07T05:31:56Z","expires_at":"2023-11-07T05:31:56Z","files":{"submitted":1,"included":1,"excluded":1,"preexisting_modified":["\u003cstring>"]},"scanners":[{"scanner":"oss","ran":true,"reason":"not_enabled"}],"evaluated":{"policies":123,"detections":123},"not_evaluated":[{"policy":{"id":123,"name":"\u003cstring>","revision":"\u003cstring>"},"reason":"\u003cstring>","detail":"\u003cstring>"}],"violations":[{"policy":{"id":123,"name":"\u003cstring>","revision":"\u003cstring>"},"verdict":"block","findings":[{"path":"\u003cstring>","kind":"\u003cstring>","summary":"\u003cstring>","line":123,"evidence_ref":"\u003cstring>"}],"remediation":{"tier":"A","summary":"\u003cstring>","prompt":"\u003cstring>"}}],"url":"\u003cstring>","name":"\u003cstring>","gate":"pass","finished_at":"2023-11-07T05:31:56Z","files_total":123,"error_code":"\u003cstring>","error_message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"0bb11d78-fd73-460a-b3f0-50a710a226c4":{"description":"Malformed request body.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Machine-readable error code. `source_not_available` when WFP upload lands).","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"b7289f47-e731-420b-b483-0f9b8da61588":{"description":"Not authenticated.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Machine-readable error code. `source_not_available` when WFP upload lands).","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"cb819dd6-26e0-4acd-b203-57b8f4c9309b":{"description":"Missing `scans:write`, API key scanner restriction, or an enabled scanner; or a requested scanner the organization has not enabled.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Machine-readable error code. `source_not_available` when WFP upload lands).","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"8eb178b7-ca62-4874-a9a2-fcb782f1fc4a":{"description":"Validation failure. Possible codes:\n * `project_not_found`\n * `project_archived`\n * `invalid_source_set` — neither `files` nor `diff`, both, an empty set, a binary or non-UTF-8 payload, or an unsafe path.\n * `source_set_too_large` — names the cap and the measured size.\n * `producer_not_self_check` — the resolved producer is not `pre_commit` or `mcp`, so this submission is a governed Scan and belongs on `POST /v1/scans`.\n * `invalid_scan_context` — `scan_context` carried a value outside this contract's enums.\n * `coverage_promotion_rejected` — a Self-check is always `partial` and can never be promoted to `full`.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Machine-readable error code. `source_not_available` when WFP upload lands).","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"044b1aa4-bef2-430b-bd04-5a8e9add18c6":{"bearerAuth":{"type":"http","scheme":"bearer","description":"An Earnie API key, sent as `Authorization: Bearer sk_earnie_...`. Create one under Settings > API keys. The key's scopes decide which operations it may call.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"78824d01-63cc-41fd-9d19-c3590c2af6c2":{"url":"https://{tenant}.earnie.dev","description":"Your Earnie deployment","variables":{"tenant":{"default":"your-company","description":"Your organization's Earnie address, as shown in your browser when you sign in."}}}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"An Earnie API key, sent as `Authorization: Bearer sk_earnie_...`. Create one under Settings > API keys. The key's scopes decide which operations it may call.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"An Earnie API key, sent as `Authorization: Bearer sk_earnie_...`. Create one under Settings > API keys. The key's scopes decide which operations it may call.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/earnie/scans-openapi.json"},"subdomain":"scanoss","siteName":"SCANOSS documentation","title":"Run a Self-check over an inline SourceSet - SCANOSS documentation","navMaps":{"firstHrefInVersion":{"v2":{"href":"/earnie/api-reference/scans/scans/run-a-self-check-over-an-inline-sourceset","matchLevel":0},"v1":{"href":"/en/latest/introduction/what-is-scanoss","matchLevel":4}},"firstHrefInLanguage":{}},"lastModified":"2026-10-07T10:42:13.545Z","originalFileLocation":"earnie/api-reference/scans/scans/run-a-self-check-over-an-inline-sourceset.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=\"Creates a Self-check from an inline SourceSet supplied in this one request — files: [{path, content}] or a unified diff, no plan-folder / ingest / commit-ingest round trips. The server materializes a tmpdir and runs the same scanners, enrichments and policy engine a governed Scan runs. A Self-check never materializes Findings, never touches the Project\u0026#x27;s posture, and is purged after 30 days. It consumes credits exactly as a Scan does, because the same engines compute. coverage is always partial: everything the submitted content allows to detect fires — a crypto call in a snippet, an OSS snippet match and the purls it enriches to, a manifest\u0026#x27;s declared dependencies — while a policy the SourceSet cannot answer is reported in not_evaluated[] with a reason rather than passing silently. The call is synchronous within a budget (default 45 s, organization-configurable). Past it the response is still 200, with status: running and the Self-check\u0026#x27;s id; poll GET /v1/self-checks/{selfCheckId} with that id. Both shapes are the same SelfCheck resource, so a client never branches on two schemas.\">\u003cmeta data-mint-head name=\"application-name\" content=\"SCANOSS documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/scanoss/KZfWE-Zg_gP00ddS/_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/scanoss/KZfWE-Zg_gP00ddS/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/scanoss/KZfWE-Zg_gP00ddS/_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/scanoss/KZfWE-Zg_gP00ddS/_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/scanoss/KZfWE-Zg_gP00ddS/_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/scanoss/KZfWE-Zg_gP00ddS/_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/scanoss/KZfWE-Zg_gP00ddS/_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/scanoss/KZfWE-Zg_gP00ddS/_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/scanoss/KZfWE-Zg_gP00ddS/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Run a Self-check over an inline SourceSet - SCANOSS documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Creates a Self-check from an inline SourceSet supplied in this one request — files: [{path, content}] or a unified diff, no plan-folder / ingest / commit-ingest round trips. The server materializes a tmpdir and runs the same scanners, enrichments and policy engine a governed Scan runs. A Self-check never materializes Findings, never touches the Project\u0026#x27;s posture, and is purged after 30 days. It consumes credits exactly as a Scan does, because the same engines compute. coverage is always partial: everything the submitted content allows to detect fires — a crypto call in a snippet, an OSS snippet match and the purls it enriches to, a manifest\u0026#x27;s declared dependencies — while a policy the SourceSet cannot answer is reported in not_evaluated[] with a reason rather than passing silently. The call is synchronous within a budget (default 45 s, organization-configurable). Past it the response is still 200, with status: running and the Self-check\u0026#x27;s id; poll GET /v1/self-checks/{selfCheckId} with that id. Both shapes are the same SelfCheck resource, so a client never branches on two schemas.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"SCANOSS documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.scanoss.com/earnie/api-reference/scans/scans/run-a-self-check-over-an-inline-sourceset\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://scanoss.mintlify.site/_mintlify/api/og/v2?division=scans\u0026amp;title=Run+a+Self-check+over+an+inline+SourceSet\u0026amp;description=Creates+a+Self-check+from+an+inline+SourceSet+supplied+in+this+one+request+%E2%80%94+%60files%3A+%5B%7Bpath%2C+content%7D%5D%60+or+a+unified+%60diff%60%2C+no+plan-folder+%2F+ingest+%2F+commit-in\u0026amp;theme=27507c7cd4c9b47ed5abe8b8\u0026amp;signature=afa46054fca0305004593a9997864b73913a8611a621f3112b35f1b10b60a04b\">\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=\"Run a Self-check over an inline SourceSet - SCANOSS documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Creates a Self-check from an inline SourceSet supplied in this one request — files: [{path, content}] or a unified diff, no plan-folder / ingest / commit-ingest round trips. The server materializes a tmpdir and runs the same scanners, enrichments and policy engine a governed Scan runs. A Self-check never materializes Findings, never touches the Project\u0026#x27;s posture, and is purged after 30 days. It consumes credits exactly as a Scan does, because the same engines compute. coverage is always partial: everything the submitted content allows to detect fires — a crypto call in a snippet, an OSS snippet match and the purls it enriches to, a manifest\u0026#x27;s declared dependencies — while a policy the SourceSet cannot answer is reported in not_evaluated[] with a reason rather than passing silently. The call is synchronous within a budget (default 45 s, organization-configurable). Past it the response is still 200, with status: running and the Self-check\u0026#x27;s id; poll GET /v1/self-checks/{selfCheckId} with that id. Both shapes are the same SelfCheck resource, so a client never branches on two schemas.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://scanoss.mintlify.site/_mintlify/api/og/v2?division=scans\u0026amp;title=Run+a+Self-check+over+an+inline+SourceSet\u0026amp;description=Creates+a+Self-check+from+an+inline+SourceSet+supplied+in+this+one+request+%E2%80%94+%60files%3A+%5B%7Bpath%2C+content%7D%5D%60+or+a+unified+%60diff%60%2C+no+plan-folder+%2F+ingest+%2F+commit-in\u0026amp;theme=27507c7cd4c9b47ed5abe8b8\u0026amp;signature=afa46054fca0305004593a9997864b73913a8611a621f3112b35f1b10b60a04b\">\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/scanoss/KZfWE-Zg_gP00ddS/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"SCANOSS documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#FF6A1A\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.scanoss.com/earnie/api-reference/scans/scans/run-a-self-check-over-an-inline-sourceset\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/earnie/api-reference/scans/scans/run-a-self-check-over-an-inline-sourceset.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.scanoss.com/#organization\",\"name\":\"SCANOSS documentation\",\"url\":\"https://docs.scanoss.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/scanoss/9UP7eHL2Z_rQPx8l/scanoss-logo-horizontal-positive.svg?fit=max\u0026auto=format\u0026n=9UP7eHL2Z_rQPx8l\u0026q=85\u0026s=686c4487013423ef804e2e83983c76ef\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.scanoss.com#website\",\"name\":\"SCANOSS documentation\",\"url\":\"https://docs.scanoss.com\",\"publisher\":{\"@id\":\"https://docs.scanoss.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.scanoss.com/earnie/api-reference/scans/scans/run-a-self-check-over-an-inline-sourceset#webpage\",\"url\":\"https://docs.scanoss.com/earnie/api-reference/scans/scans/run-a-self-check-over-an-inline-sourceset\",\"name\":\"Run a Self-check over an inline SourceSet\",\"description\":\"Creates a Self-check from an inline SourceSet supplied in this one request — files: [{path, content}] or a unified diff, no plan-folder / ingest / commit-ingest round trips. The server materializes a tmpdir and runs the same scanners, enrichments and policy engine a governed Scan runs. A Self-check never materializes Findings, never touches the Project's posture, and is purged after 30 days. It consumes credits exactly as a Scan does, because the same engines compute. coverage is always partial: everything the submitted content allows to detect fires — a crypto call in a snippet, an OSS snippet match and the purls it enriches to, a manifest's declared dependencies — while a policy the SourceSet cannot answer is reported in not_evaluated[] with a reason rather than passing silently. The call is synchronous within a budget (default 45 s, organization-configurable). Past it the response is still 200, with status: running and the Self-check's id; poll GET /v1/self-checks/{selfCheckId} with that id. Both shapes are the same SelfCheck resource, so a client never branches on two schemas.\",\"dateModified\":\"2026-10-07T10:42:13.545Z\",\"isPartOf\":{\"@id\":\"https://docs.scanoss.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.scanoss.com/earnie/api-reference/scans/scans/run-a-self-check-over-an-inline-sourceset#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.scanoss.com/earnie/api-reference/scans/scans/run-a-self-check-over-an-inline-sourceset#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://docs.scanoss.com/en/latest/earnie/api/using-the-api\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Scans\",\"item\":\"https://docs.scanoss.com/earnie/api-reference/scans/scans/the-organizations-ai-provenance-posture-across-a-scope-of-projects\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"scans\",\"item\":\"https://docs.scanoss.com/earnie/api-reference/scans/scans/the-organizations-ai-provenance-posture-across-a-scope-of-projects\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Run a Self-check over an inline SourceSet\",\"item\":\"https://docs.scanoss.com/earnie/api-reference/scans/scans/run-a-self-check-over-an-inline-sourceset\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.scanoss.com/earnie/api-reference/scans/scans/run-a-self-check-over-an-inline-sourceset#apireference\",\"headline\":\"Run a Self-check over an inline SourceSet\",\"name\":\"Run a Self-check over an inline SourceSet\",\"description\":\"Creates a Self-check from an inline SourceSet supplied in this one request — files: [{path, content}] or a unified diff, no plan-folder / ingest / commit-ingest round trips. The server materializes a tmpdir and runs the same scanners, enrichments and policy engine a governed Scan runs. A Self-check never materializes Findings, never touches the Project's posture, and is purged after 30 days. It consumes credits exactly as a Scan does, because the same engines compute. coverage is always partial: everything the submitted content allows to detect fires — a crypto call in a snippet, an OSS snippet match and the purls it enriches to, a manifest's declared dependencies — while a policy the SourceSet cannot answer is reported in not_evaluated[] with a reason rather than passing silently. The call is synchronous within a budget (default 45 s, organization-configurable). Past it the response is still 200, with status: running and the Self-check's id; poll GET /v1/self-checks/{selfCheckId} with that id. Both shapes are the same SelfCheck resource, so a client never branches on two schemas.\",\"url\":\"https://docs.scanoss.com/earnie/api-reference/scans/scans/run-a-self-check-over-an-inline-sourceset\",\"mainEntityOfPage\":{\"@id\":\"https://docs.scanoss.com/earnie/api-reference/scans/scans/run-a-self-check-over-an-inline-sourceset#webpage\"},\"dateModified\":\"2026-10-07T10:42:13.545Z\",\"publisher\":{\"@id\":\"https://docs.scanoss.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.scanoss.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"SCANOSS documentation\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"SCANOSS documentation\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/earnie/api-reference/scans/scans/run-a-self-check-over-an-inline-sourceset.md","siteName":"SCANOSS documentation","nav":{"global":null,"versions":[{"version":"v2","default":true,"tabs":[{"tab":"Earnie","hidden":false,"groups":[{"group":"Get Started","expanded":false,"pages":[{"title":"What Is Earnie?","sidebarTitle":"What Is Earnie?","href":"/en/latest/earnie/introduction"},{"title":"Deployment Options and Data Flow","sidebarTitle":"Deployment and Data Flow","href":"/en/latest/earnie/deployment"},{"group":"Self-Hosting","expanded":false,"pages":[{"title":"Self-Hosting Requirements","sidebarTitle":"Self-Hosting Requirements","href":"/en/latest/earnie/self-hosting/self-hosting-requirements"},{"title":"Installing Earnie","sidebarTitle":"Installing Earnie","href":"/en/latest/earnie/self-hosting/installation"},{"title":"Running Earnie on a Cloud Provider","sidebarTitle":"Cloud Providers","href":"/en/latest/earnie/self-hosting/cloud-providers"},{"title":"Upgrading and Backing Up","sidebarTitle":"Upgrading and Backing Up","href":"/en/latest/earnie/self-hosting/upgrading-and-backups"},{"title":"Releases and Release Notes","sidebarTitle":"Releases","href":"/en/latest/earnie/self-hosting/releases"},{"title":"Outbound Network Calls","sidebarTitle":"Outbound Network Calls","href":"/en/latest/earnie/self-hosting/outbound-network-calls"}]},{"title":"Setting Up Your Workspace","sidebarTitle":"Workspace Setup","href":"/en/latest/earnie/getting-started/workspace-setup"},{"title":"Connecting a Repository","sidebarTitle":"Connecting a Repository","href":"/en/latest/earnie/getting-started/connecting-a-repository"},{"title":"Your First Scan","sidebarTitle":"First Scan","href":"/en/latest/earnie/getting-started/first-scan"}]},{"group":"Development","expanded":false,"pages":[{"title":"Earnie CLI","sidebarTitle":"Earnie CLI","href":"/en/latest/earnie/using-earnie/earnie-cli"},{"group":"Coding Agents (MCP)","expanded":false,"pages":[{"title":"Earnie MCP","sidebarTitle":"Overview","href":"/en/latest/earnie/mcp/overview"},{"title":"Connecting an AI Client","sidebarTitle":"Connecting a Client","href":"/en/latest/earnie/mcp/connecting-a-client"},{"title":"Using Earnie Through MCP","sidebarTitle":"Tools","href":"/en/latest/earnie/mcp/tools"},{"title":"Troubleshooting Earnie MCP","sidebarTitle":"Troubleshooting","href":"/en/latest/earnie/mcp/troubleshooting"}]},{"title":"Self-Checks","sidebarTitle":"Self-Checks","href":"/en/latest/earnie/using-earnie/self-checks"}]},{"group":"Pull Requests \u0026 CI","expanded":false,"pages":[{"title":"When the Gate Blocks a Merge","sidebarTitle":"Merge Gate","href":"/en/latest/earnie/using-earnie/merge-gate"},{"title":"Scan Configuration","sidebarTitle":"Scan Configuration","href":"/en/latest/earnie/using-earnie/scan-configuration"}]},{"group":"Governance","expanded":false,"pages":[{"title":"Reading the Dashboard","sidebarTitle":"Dashboard","href":"/en/latest/earnie/using-earnie/dashboard"},{"title":"Dependencies","sidebarTitle":"Dependencies","href":"/en/latest/earnie/using-earnie/dependencies"},{"title":"Vulnerability Statements (VEX)","sidebarTitle":"Vulnerabilities","href":"/en/latest/earnie/using-earnie/vulnerabilities"},{"title":"What a Project Uses, Reaches and Blocks","sidebarTitle":"Cryptography","href":"/en/latest/earnie/using-earnie/cryptography"},{"title":"Across Every Project","sidebarTitle":"All Projects","href":"/en/latest/earnie/using-earnie/all-projects"},{"title":"Triaging Findings","sidebarTitle":"Triaging Findings","href":"/en/latest/earnie/using-earnie/triaging-findings"},{"title":"Setting Your First Policy","sidebarTitle":"Setting Policies","href":"/en/latest/earnie/using-earnie/setting-policies"},{"title":"Notifications","sidebarTitle":"Notifications","href":"/en/latest/earnie/using-earnie/notifications"},{"title":"Language","sidebarTitle":"Language","href":"/en/latest/earnie/using-earnie/language"},{"group":"Domains","expanded":false,"pages":[{"title":"Cryptography","sidebarTitle":"Cryptography","href":"/en/latest/earnie/domains/cryptography"},{"title":"AI Provenance","sidebarTitle":"AI Provenance","href":"/en/latest/earnie/using-earnie/ai-provenance"}]}]},{"group":"Evidence \u0026 Audit","expanded":false,"pages":[{"title":"Exporting an SBOM","sidebarTitle":"Exporting SBOMs","href":"/en/latest/earnie/evidence/exporting-sboms"},{"title":"Reports","sidebarTitle":"Reports","href":"/en/latest/earnie/evidence/project-reports"},{"title":"Compliance Packages","sidebarTitle":"Compliance Packages","href":"/en/latest/earnie/evidence/compliance-packages"},{"title":"Audit Log","sidebarTitle":"Audit Log","href":"/en/latest/earnie/evidence/audit-log"}]},{"group":"Administration","expanded":false,"pages":[{"title":"Team and Roles","sidebarTitle":"Team \u0026 Roles","href":"/en/latest/earnie/administration/team-and-roles"},{"title":"API Keys","sidebarTitle":"API Keys","href":"/en/latest/earnie/administration/api-keys"}]},{"group":"Migrating","expanded":false,"pages":[{"title":"Migrating from SCANOSS Tools","sidebarTitle":"From SCANOSS Tools","href":"/en/latest/earnie/migrating/from-scanoss-tools"}]},{"group":"API Reference","expanded":false,"pages":[{"title":"Using the API","sidebarTitle":"Using the API","href":"/en/latest/earnie/api/using-the-api"},{"group":"Projects","pages":[{"group":"projects","pages":[{"title":"List projects for the authenticated organisation","deprecated":null,"version":null,"openapi":"/api-reference/earnie/projects-openapi.json get /v1/projects","href":"/earnie/api-reference/projects/projects/list-projects-for-the-authenticated-organisation"},{"title":"Create a new project","deprecated":null,"version":null,"openapi":"/api-reference/earnie/projects-openapi.json post /v1/projects","href":"/earnie/api-reference/projects/projects/create-a-new-project"},{"title":"Get a project by ID","deprecated":null,"version":null,"openapi":"/api-reference/earnie/projects-openapi.json get /v1/projects/{projectId}","href":"/earnie/api-reference/projects/projects/get-a-project-by-id"},{"title":"Update a project's name or description","deprecated":null,"version":null,"openapi":"/api-reference/earnie/projects-openapi.json patch /v1/projects/{projectId}","href":"/earnie/api-reference/projects/projects/update-a-projects-name-or-description"},{"title":"Resolve one accessible project for a customer CLI","deprecated":null,"version":null,"openapi":"/api-reference/earnie/projects-openapi.json get /v1/projects:resolve","href":"/earnie/api-reference/projects/projects/resolve-one-accessible-project-for-a-customer-cli"}]}]},{"group":"Scans","pages":[{"group":"scans","pages":[{"title":"The organization's AI provenance posture across a scope of projects","deprecated":null,"version":null,"openapi":"/api-reference/earnie/scans-openapi.json get /v1/ai/posture","href":"/earnie/api-reference/scans/scans/the-organizations-ai-provenance-posture-across-a-scope-of-projects"},{"title":"The curated rules Earnie assesses crypto findings against","deprecated":null,"version":null,"openapi":"/api-reference/earnie/scans-openapi.json get /v1/crypto/assessment-rules","href":"/earnie/api-reference/scans/scans/the-curated-rules-earnie-assesses-crypto-findings-against"},{"title":"The organization's crypto posture across a scope of projects","deprecated":null,"version":null,"openapi":"/api-reference/earnie/scans-openapi.json get /v1/crypto/posture","href":"/earnie/api-reference/scans/scans/the-organizations-crypto-posture-across-a-scope-of-projects"},{"title":"Get the project's AI scanner settings","deprecated":null,"version":null,"openapi":"/api-reference/earnie/scans-openapi.json get /v1/projects/{projectId}/ai-settings","href":"/earnie/api-reference/scans/scans/get-the-projects-ai-scanner-settings"},{"title":"Replace the project's AI scanner settings","deprecated":null,"version":null,"openapi":"/api-reference/earnie/scans-openapi.json put /v1/projects/{projectId}/ai-settings","href":"/earnie/api-reference/scans/scans/replace-the-projects-ai-scanner-settings"},{"title":"Crypto algorithms detected in one project","deprecated":null,"version":null,"openapi":"/api-reference/earnie/scans-openapi.json get /v1/projects/{projectId}/crypto-algorithms","href":"/earnie/api-reference/scans/scans/crypto-algorithms-detected-in-one-project"},{"title":"Dependency-internal crypto inventory for one component","deprecated":null,"version":null,"openapi":"/api-reference/earnie/scans-openapi.json get /v1/projects/{projectId}/crypto-inventory","href":"/earnie/api-reference/scans/scans/dependency-internal-crypto-inventory-for-one-component"},{"title":"Declare a model upload, or resume the one in flight","deprecated":null,"version":null,"openapi":"/api-reference/earnie/scans-openapi.json post /v1/projects/{projectId}/model-uploads","href":"/earnie/api-reference/scans/scans/declare-a-model-upload-or-resume-the-one-in-flight"},{"title":"Read an upload and its offset","deprecated":null,"version":null,"openapi":"/api-reference/earnie/scans-openapi.json get /v1/projects/{projectId}/model-uploads/{uploadId}","href":"/earnie/api-reference/scans/scans/read-an-upload-and-its-offset"},{"title":"Send one window of an upload","deprecated":null,"version":null,"openapi":"/api-reference/earnie/scans-openapi.json put /v1/projects/{projectId}/model-uploads/{uploadId}","href":"/earnie/api-reference/scans/scans/send-one-window-of-an-upload"},{"title":"Abandon an upload","deprecated":null,"version":null,"openapi":"/api-reference/earnie/scans-openapi.json delete /v1/projects/{projectId}/model-uploads/{uploadId}","href":"/earnie/api-reference/scans/scans/abandon-an-upload"},{"title":"List the project's Models and its uploads in flight","deprecated":null,"version":null,"openapi":"/api-reference/earnie/scans-openapi.json get /v1/projects/{projectId}/models","href":"/earnie/api-reference/scans/scans/list-the-projects-models-and-its-uploads-in-flight"},{"title":"Get one Model","deprecated":null,"version":null,"openapi":"/api-reference/earnie/scans-openapi.json get /v1/projects/{projectId}/models/{modelId}","href":"/earnie/api-reference/scans/scans/get-one-model"},{"title":"Delete a Model","deprecated":null,"version":null,"openapi":"/api-reference/earnie/scans-openapi.json delete /v1/projects/{projectId}/models/{modelId}","href":"/earnie/api-reference/scans/scans/delete-a-model"},{"title":"List scans","deprecated":null,"version":null,"openapi":"/api-reference/earnie/scans-openapi.json get /v1/scans","href":"/earnie/api-reference/scans/scans/list-scans"},{"title":"Upload a source archive and start a scan","deprecated":null,"version":null,"openapi":"/api-reference/earnie/scans-openapi.json post /v1/scans","href":"/earnie/api-reference/scans/scans/upload-a-source-archive-and-start-a-scan"},{"title":"Get authoritative project scan summary","deprecated":null,"version":null,"openapi":"/api-reference/earnie/scans-openapi.json get /v1/scans/projects/{projectId}/state","href":"/earnie/api-reference/scans/scans/get-authoritative-project-scan-summary"},{"title":"Project posture rollup for the Audit landing","deprecated":null,"version":null,"openapi":"/api-reference/earnie/scans-openapi.json get /v1/scans/projects/{projectId}/summary","href":"/earnie/api-reference/scans/scans/project-posture-rollup-for-the-audit-landing"},{"title":"Project crypto posture rollup","deprecated":null,"version":null,"openapi":"/api-reference/earnie/scans-openapi.json get /v1/scans/projects/{projectId}/summary/crypto","href":"/earnie/api-reference/scans/scans/project-crypto-posture-rollup"},{"title":"Posture for every project in scope, in one response","deprecated":null,"version":null,"openapi":"/api-reference/earnie/scans-openapi.json get /v1/scans/projects:posture","href":"/earnie/api-reference/scans/scans/posture-for-every-project-in-scope-in-one-response"},{"title":"Get this deployment's upload limits","deprecated":null,"version":null,"openapi":"/api-reference/earnie/scans-openapi.json get /v1/scans/upload-limits","href":"/earnie/api-reference/scans/scans/get-this-deployments-upload-limits"},{"title":"Fetch a single scan by id","deprecated":null,"version":null,"openapi":"/api-reference/earnie/scans-openapi.json get /v1/scans/{scanId}","href":"/earnie/api-reference/scans/scans/fetch-a-single-scan-by-id"},{"title":"Upload or resume a user-supplied archive object","deprecated":null,"version":null,"openapi":"/api-reference/earnie/scans-openapi.json put /v1/scans/{scanId}/archive","href":"/earnie/api-reference/scans/scans/upload-or-resume-a-user-supplied-archive-object"},{"title":"Read the upload offset of an archive object","deprecated":null,"version":null,"openapi":"/api-reference/earnie/scans-openapi.json head /v1/scans/{scanId}/archive","href":"/earnie/api-reference/scans/scans/read-the-upload-offset-of-an-archive-object"},{"title":"The Scan's Audit Trail","deprecated":null,"version":null,"openapi":"/api-reference/earnie/scans-openapi.json get /v1/scans/{scanId}/audit","href":"/earnie/api-reference/scans/scans/the-scans-audit-trail"},{"title":"Compare crypto findings with another completed scan","deprecated":null,"version":null,"openapi":"/api-reference/earnie/scans-openapi.json get /v1/scans/{scanId}/crypto/diff","href":"/earnie/api-reference/scans/scans/compare-crypto-findings-with-another-completed-scan"},{"title":"List all files in the scan (flat)","deprecated":null,"version":null,"openapi":"/api-reference/earnie/scans-openapi.json get /v1/scans/{scanId}/files","href":"/earnie/api-reference/scans/scans/list-all-files-in-the-scan-flat"},{"title":"Stream a single file's bytes from the retained archive","deprecated":null,"version":null,"openapi":"/api-reference/earnie/scans-openapi.json get /v1/scans/{scanId}/files/content","href":"/earnie/api-reference/scans/scans/stream-a-single-files-bytes-from-the-retained-archive"},{"title":"Keep-set ingest cursor — received and missing paths","deprecated":null,"version":null,"openapi":"/api-reference/earnie/scans-openapi.json get /v1/scans/{scanId}/ingest","href":"/earnie/api-reference/scans/scans/keep-set-ingest-cursor-—-received-and-missing-paths"},{"title":"Stream kept files as a tar","deprecated":null,"version":null,"openapi":"/api-reference/earnie/scans-openapi.json put /v1/scans/{scanId}/ingest","href":"/earnie/api-reference/scans/scans/stream-kept-files-as-a-tar"},{"title":"Match metadata + component + licenses for one file","deprecated":null,"version":null,"openapi":"/api-reference/earnie/scans-openapi.json get /v1/scans/{scanId}/matches","href":"/earnie/api-reference/scans/scans/match-metadata-+-component-+-licenses-for-one-file"},{"title":"Proxy the bytes of an OSS file from the SCANOSS file-content service","deprecated":null,"version":null,"openapi":"/api-reference/earnie/scans-openapi.json get /v1/scans/{scanId}/oss-files/content","href":"/earnie/api-reference/scans/scans/proxy-the-bytes-of-an-oss-file-from-the-scanoss-file-content-service"},{"title":"Per-scan rollup for the results-overview dashboard","deprecated":null,"version":null,"openapi":"/api-reference/earnie/scans-openapi.json get /v1/scans/{scanId}/summary","href":"/earnie/api-reference/scans/scans/per-scan-rollup-for-the-results-overview-dashboard"},{"title":"Lazy folder expansion with aggregated state","deprecated":null,"version":null,"openapi":"/api-reference/earnie/scans-openapi.json get /v1/scans/{scanId}/tree","href":"/earnie/api-reference/scans/scans/lazy-folder-expansion-with-aggregated-state"},{"title":"Cancel an in-progress scan","deprecated":null,"version":null,"openapi":"/api-reference/earnie/scans-openapi.json post /v1/scans/{scanId}:cancel","href":"/earnie/api-reference/scans/scans/cancel-an-in-progress-scan"},{"title":"Seal the keep-set archive and start scanning","deprecated":null,"version":null,"openapi":"/api-reference/earnie/scans-openapi.json post /v1/scans/{scanId}:commit-ingest","href":"/earnie/api-reference/scans/scans/seal-the-keep-set-archive-and-start-scanning"},{"title":"Explicitly rerun a scan","deprecated":null,"version":null,"openapi":"/api-reference/earnie/scans-openapi.json post /v1/scans/{scanId}:rerun","href":"/earnie/api-reference/scans/scans/explicitly-rerun-a-scan"},{"title":"Retry a degraded provider publication","deprecated":null,"version":null,"openapi":"/api-reference/earnie/scans-openapi.json post /v1/scans/{scanId}:retry-publication","href":"/earnie/api-reference/scans/scans/retry-a-degraded-provider-publication"},{"title":"Import a foreign SBOM document as a partial-coverage scan","deprecated":null,"version":null,"openapi":"/api-reference/earnie/scans-openapi.json post /v1/scans:import-sbom","href":"/earnie/api-reference/scans/scans/import-a-foreign-sbom-document-as-a-partial-coverage-scan"},{"title":"Create a receiving scan for a resumable archive object","deprecated":null,"version":null,"openapi":"/api-reference/earnie/scans-openapi.json post /v1/scans:plan-archive","href":"/earnie/api-reference/scans/scans/create-a-receiving-scan-for-a-resumable-archive-object"},{"title":"Plan a folder scan — keep engine then 202 receiving","deprecated":null,"version":null,"openapi":"/api-reference/earnie/scans-openapi.json post /v1/scans:plan-folder","href":"/earnie/api-reference/scans/scans/plan-a-folder-scan-—-keep-engine-then-202-receiving"},{"title":"List Self-checks","description":"Self-checks are listed here and nowhere else: `GET /v1/scans` returns governed Scans only, so a developer's twenty commits a day never crowd out a Project's scan history.","deprecated":null,"version":null,"openapi":"/api-reference/earnie/scans-openapi.json get /v1/self-checks","href":"/earnie/api-reference/scans/scans/list-self-checks"},{"title":"Run a Self-check over an inline SourceSet","deprecated":null,"version":null,"openapi":"/api-reference/earnie/scans-openapi.json post /v1/self-checks","href":"/earnie/api-reference/scans/scans/run-a-self-check-over-an-inline-sourceset"},{"title":"Get one Self-check","description":"The polling target for a creation call that returned `status: running`, and the deep link's target.\n\nA purged Self-check answers `404 self_check_not_found`: after 30 days the run is gone by design, and its `selfcheck.*` decision log in the Audit Log is what remains.","deprecated":null,"version":null,"openapi":"/api-reference/earnie/scans-openapi.json get /v1/self-checks/{selfCheckId}","href":"/earnie/api-reference/scans/scans/get-one-self-check"}]}]},{"group":"Findings","pages":[{"group":"audit","pages":[{"title":"List the durable audit-event trail for a subject (e.g. a finding)","deprecated":null,"version":null,"openapi":"/api-reference/earnie/triage-openapi.json get /v1/audit/events","href":"/earnie/api-reference/triage/audit/list-the-durable-audit-event-trail-for-a-subject-eg-a-finding"}]},{"group":"findings","pages":[{"title":"List findings with optional filters","deprecated":null,"version":null,"openapi":"/api-reference/earnie/triage-openapi.json get /v1/findings","href":"/earnie/api-reference/triage/findings/list-findings-with-optional-filters"},{"title":"Create a new finding (source=api)","deprecated":null,"version":null,"openapi":"/api-reference/earnie/triage-openapi.json post /v1/findings","href":"/earnie/api-reference/triage/findings/create-a-new-finding-source=api"},{"title":"Bulk-reopen findings by component/path scope","deprecated":null,"version":null,"openapi":"/api-reference/earnie/triage-openapi.json post /v1/findings/actions/bulk-reopen","href":"/earnie/api-reference/triage/findings/bulk-reopen-findings-by-componentpath-scope"},{"title":"Bulk-resolve open OSS findings by component/path scope","deprecated":null,"version":null,"openapi":"/api-reference/earnie/triage-openapi.json post /v1/findings/actions/bulk-resolve","href":"/earnie/api-reference/triage/findings/bulk-resolve-open-oss-findings-by-componentpath-scope"},{"title":"Bulk-resolve open OSS findings across every project","deprecated":null,"version":null,"openapi":"/api-reference/earnie/triage-openapi.json post /v1/findings/actions/bulk-resolve-org-wide","href":"/earnie/api-reference/triage/findings/bulk-resolve-open-oss-findings-across-every-project"},{"title":"Count the open findings a bulk-resolve would affect","deprecated":null,"version":null,"openapi":"/api-reference/earnie/triage-openapi.json post /v1/findings/actions/bulk-resolve-preview","href":"/earnie/api-reference/triage/findings/count-the-open-findings-a-bulk-resolve-would-affect"},{"title":"List findings aggregated by component (purl@version)","deprecated":null,"version":null,"openapi":"/api-reference/earnie/triage-openapi.json get /v1/findings/components","href":"/earnie/api-reference/triage/findings/list-findings-aggregated-by-component-purl@version"},{"title":"Membership Audit Trail for a component (base purl) selection","deprecated":null,"version":null,"openapi":"/api-reference/earnie/triage-openapi.json get /v1/findings/components/audit-trail","href":"/earnie/api-reference/triage/findings/membership-audit-trail-for-a-component-base-purl-selection"},{"title":"List the filterable facet values a set of findings carries, with counts","deprecated":null,"version":null,"openapi":"/api-reference/earnie/triage-openapi.json get /v1/findings/facets","href":"/earnie/api-reference/triage/findings/list-the-filterable-facet-values-a-set-of-findings-carries-with-counts"},{"title":"List findings aggregated by source file (review queue rows)","deprecated":null,"version":null,"openapi":"/api-reference/earnie/triage-openapi.json get /v1/findings/files","href":"/earnie/api-reference/triage/findings/list-findings-aggregated-by-source-file-review-queue-rows"},{"title":"Get a single finding by ID","deprecated":null,"version":null,"openapi":"/api-reference/earnie/triage-openapi.json get /v1/findings/{findingId}","href":"/earnie/api-reference/triage/findings/get-a-single-finding-by-id"},{"title":"Assign a finding to an actor (also serves as defer/reassign)","deprecated":null,"version":null,"openapi":"/api-reference/earnie/triage-openapi.json post /v1/findings/{findingId}/actions/assign","href":"/earnie/api-reference/triage/findings/assign-a-finding-to-an-actor-also-serves-as-deferreassign"},{"title":"Create a configuration rule directly from a finding (mark-as-original)","deprecated":null,"version":null,"openapi":"/api-reference/earnie/triage-openapi.json post /v1/findings/{findingId}/actions/create-rule","href":"/earnie/api-reference/triage/findings/create-a-configuration-rule-directly-from-a-finding-mark-as-original"},{"title":"Reopen a resolved or assigned finding","deprecated":null,"version":null,"openapi":"/api-reference/earnie/triage-openapi.json post /v1/findings/{findingId}/actions/reopen","href":"/earnie/api-reference/triage/findings/reopen-a-resolved-or-assigned-finding"},{"title":"Resolve a finding with a reason","deprecated":null,"version":null,"openapi":"/api-reference/earnie/triage-openapi.json post /v1/findings/{findingId}/actions/resolve","href":"/earnie/api-reference/triage/findings/resolve-a-finding-with-a-reason"},{"title":"Suppress or unsuppress a finding (orthogonal to triage state)","deprecated":null,"version":null,"openapi":"/api-reference/earnie/triage-openapi.json post /v1/findings/{findingId}/actions/suppress","href":"/earnie/api-reference/triage/findings/suppress-or-unsuppress-a-finding-orthogonal-to-triage-state"},{"title":"Stream the dependency's resolved source for a crypto finding","deprecated":null,"version":null,"openapi":"/api-reference/earnie/triage-openapi.json get /v1/findings/{findingId}/crypto-source","href":"/earnie/api-reference/triage/findings/stream-the-dependencys-resolved-source-for-a-crypto-finding"}]},{"group":"resolutions","pages":[{"title":"List resolutions (pending review queue)","deprecated":null,"version":null,"openapi":"/api-reference/earnie/triage-openapi.json get /v1/resolutions","href":"/earnie/api-reference/triage/resolutions/list-resolutions-pending-review-queue"},{"title":"Weekly decision throughput for a project, split by actor class","deprecated":null,"version":null,"openapi":"/api-reference/earnie/triage-openapi.json get /v1/resolutions/throughput","href":"/earnie/api-reference/triage/resolutions/weekly-decision-throughput-for-a-project-split-by-actor-class"},{"title":"Revert a pending_review resolution","deprecated":null,"version":null,"openapi":"/api-reference/earnie/triage-openapi.json post /v1/resolutions/{resolutionId}/actions/revert","href":"/earnie/api-reference/triage/resolutions/revert-a-pending_review-resolution"}]}]},{"group":"Policies","pages":[{"group":"policies","pages":[{"title":"List current policy verdicts for a finding","deprecated":null,"version":null,"openapi":"/api-reference/earnie/policies-openapi.json get /v1/findings/{findingId}/policy-verdicts","href":"/earnie/api-reference/policies/policies/list-current-policy-verdicts-for-a-finding"},{"title":"List named regulatory policy template sets","deprecated":null,"version":null,"openapi":"/api-reference/earnie/policies-openapi.json get /v1/policies/template-sets","href":"/earnie/api-reference/policies/policies/list-named-regulatory-policy-template-sets"},{"title":"List the projects a policy is attached to","deprecated":null,"version":null,"openapi":"/api-reference/earnie/policies-openapi.json get /v1/policies/{id}/attachments","href":"/earnie/api-reference/policies/policies/list-the-projects-a-policy-is-attached-to"},{"title":"List (and page) policy approval history for a project","deprecated":null,"version":null,"openapi":"/api-reference/earnie/policies-openapi.json get /v1/projects/{projectId}/approvals","href":"/earnie/api-reference/policies/policies/list-and-page-policy-approval-history-for-a-project"},{"title":"List policies directly attached to a project","deprecated":null,"version":null,"openapi":"/api-reference/earnie/policies-openapi.json get /v1/projects/{projectId}/policies","href":"/earnie/api-reference/policies/policies/list-policies-directly-attached-to-a-project"},{"title":"Attach a policy directly to a project","deprecated":null,"version":null,"openapi":"/api-reference/earnie/policies-openapi.json put /v1/projects/{projectId}/policies/{policyId}","href":"/earnie/api-reference/policies/policies/attach-a-policy-directly-to-a-project"},{"title":"Clone a policy attached (or attachable) to a project","deprecated":null,"version":null,"openapi":"/api-reference/earnie/policies-openapi.json post /v1/projects/{projectId}/policies/{policyId}/clone","href":"/earnie/api-reference/policies/policies/clone-a-policy-attached-or-attachable-to-a-project"},{"title":"List immutable evaluation snapshots for an attached policy","deprecated":null,"version":null,"openapi":"/api-reference/earnie/policies-openapi.json get /v1/projects/{projectId}/policies/{policyId}/evaluations","href":"/earnie/api-reference/policies/policies/list-immutable-evaluation-snapshots-for-an-attached-policy"},{"title":"List current findings violating an attached policy","deprecated":null,"version":null,"openapi":"/api-reference/earnie/policies-openapi.json get /v1/projects/{projectId}/policies/{policyId}/violations","href":"/earnie/api-reference/policies/policies/list-current-findings-violating-an-attached-policy"},{"title":"Materialize an arbitrary, operator-chosen list of seeded templates","deprecated":null,"version":null,"openapi":"/api-reference/earnie/policies-openapi.json post /v1/projects/{projectId}/policies:from-templates","href":"/earnie/api-reference/policies/policies/materialize-an-arbitrary-operator-chosen-list-of-seeded-templates"},{"title":"Get the project's current policy posture","deprecated":null,"version":null,"openapi":"/api-reference/earnie/policies-openapi.json get /v1/projects/{projectId}/policy-posture","href":"/earnie/api-reference/policies/policies/get-the-projects-current-policy-posture"},{"title":"Enable one named regulatory policy template set","deprecated":null,"version":null,"openapi":"/api-reference/earnie/policies-openapi.json post /v1/projects/{projectId}/policy-template-sets/{setSlug}:enable","href":"/earnie/api-reference/policies/policies/enable-one-named-regulatory-policy-template-set"},{"title":"Get the project's append-only posture time series","deprecated":null,"version":null,"openapi":"/api-reference/earnie/policies-openapi.json get /v1/projects/{projectId}/posture-history","href":"/earnie/api-reference/policies/policies/get-the-projects-append-only-posture-time-series"},{"title":"What this scan was gated by","deprecated":null,"version":null,"openapi":"/api-reference/earnie/policies-openapi.json get /v1/scans/{scanId}/policy-verdicts","href":"/earnie/api-reference/policies/policies/what-this-scan-was-gated-by"}]},{"group":"API Reference","pages":[{"title":"List policies","deprecated":null,"version":null,"openapi":"/api-reference/earnie/policies-openapi.json get /v1/policies","href":"/earnie/api-reference/policies/list-policies"},{"title":"Create a policy","deprecated":null,"version":null,"openapi":"/api-reference/earnie/policies-openapi.json post /v1/policies","href":"/earnie/api-reference/policies/create-a-policy"},{"title":"Get the field catalog visible to the caller","deprecated":null,"version":null,"openapi":"/api-reference/earnie/policies-openapi.json get /v1/policies/fields","href":"/earnie/api-reference/policies/get-the-field-catalog-visible-to-the-caller"},{"title":"Search values for an endpoint-sourced field","deprecated":null,"version":null,"openapi":"/api-reference/earnie/policies-openapi.json get /v1/policies/fields/{path}/values","href":"/earnie/api-reference/policies/search-values-for-an-endpoint-sourced-field"},{"title":"List seeded policy templates","deprecated":null,"version":null,"openapi":"/api-reference/earnie/policies-openapi.json get /v1/policies/templates","href":"/earnie/api-reference/policies/list-seeded-policy-templates"},{"title":"Read one policy","deprecated":null,"version":null,"openapi":"/api-reference/earnie/policies-openapi.json get /v1/policies/{id}","href":"/earnie/api-reference/policies/read-one-policy"},{"title":"Delete a policy","deprecated":null,"version":null,"openapi":"/api-reference/earnie/policies-openapi.json delete /v1/policies/{id}","href":"/earnie/api-reference/policies/delete-a-policy"},{"title":"Partial update of a policy","deprecated":null,"version":null,"openapi":"/api-reference/earnie/policies-openapi.json patch /v1/policies/{id}","href":"/earnie/api-reference/policies/partial-update-of-a-policy"}]}]},{"group":"SBOM","pages":[{"group":"sbom","pages":[{"title":"List a project's SBOM snapshots (newest first)","deprecated":null,"version":null,"openapi":"/api-reference/earnie/sbom-openapi.json get /v1/sbom/projects/{projectId}/snapshots","href":"/earnie/api-reference/sbom/sbom/list-a-projects-sbom-snapshots-newest-first"},{"title":"Generate an SBOM snapshot from a scan","deprecated":null,"version":null,"openapi":"/api-reference/earnie/sbom-openapi.json post /v1/sbom/scans/{scanId}:generate","href":"/earnie/api-reference/sbom/sbom/generate-an-sbom-snapshot-from-a-scan"},{"title":"Fetch snapshot metadata","deprecated":null,"version":null,"openapi":"/api-reference/earnie/sbom-openapi.json get /v1/sbom/snapshots/{snapshotId}","href":"/earnie/api-reference/sbom/sbom/fetch-snapshot-metadata"},{"title":"Delete a snapshot (metadata + rendered artifacts + inventory)","deprecated":null,"version":null,"openapi":"/api-reference/earnie/sbom-openapi.json delete /v1/sbom/snapshots/{snapshotId}","href":"/earnie/api-reference/sbom/sbom/delete-a-snapshot-metadata-+-rendered-artifacts-+-inventory"},{"title":"Download a rendered SBOM document (original bytes)","deprecated":null,"version":null,"openapi":"/api-reference/earnie/sbom-openapi.json get /v1/sbom/snapshots/{snapshotId}/document","href":"/earnie/api-reference/sbom/sbom/download-a-rendered-sbom-document-original-bytes"},{"title":"Render an existing snapshot into another format","deprecated":null,"version":null,"openapi":"/api-reference/earnie/sbom-openapi.json post /v1/sbom/snapshots/{snapshotId}:render","href":"/earnie/api-reference/sbom/sbom/render-an-existing-snapshot-into-another-format"}]}]},{"group":"Estate Actions","pages":[{"group":"estate","pages":[{"title":"Poll a queued fan-out run","deprecated":null,"version":null,"openapi":"/api-reference/earnie/estate-openapi.json get /v1/estate/actions/{runId}","href":"/earnie/api-reference/estate/estate/poll-a-queued-fan-out-run"},{"title":"Attach a policy to every selected, eligible project","deprecated":null,"version":null,"openapi":"/api-reference/earnie/estate-openapi.json post /v1/estate/projects:apply-policy","href":"/earnie/api-reference/estate/estate/attach-a-policy-to-every-selected-eligible-project"},{"title":"Generate an SBOM snapshot for every selected, eligible project","deprecated":null,"version":null,"openapi":"/api-reference/earnie/estate-openapi.json post /v1/estate/projects:generate-sbom","href":"/earnie/api-reference/estate/estate/generate-an-sbom-snapshot-for-every-selected-eligible-project"},{"title":"Render a notice file for every selected, eligible project","deprecated":null,"version":null,"openapi":"/api-reference/earnie/estate-openapi.json post /v1/estate/projects:render-notice","href":"/earnie/api-reference/estate/estate/render-a-notice-file-for-every-selected-eligible-project"},{"title":"Request a re-scan for every selected, eligible project","deprecated":null,"version":null,"openapi":"/api-reference/earnie/estate-openapi.json post /v1/estate/projects:request-scan","href":"/earnie/api-reference/estate/estate/request-a-re-scan-for-every-selected-eligible-project"}]}]},{"group":"Organization Settings","pages":[{"group":"organization","pages":[{"title":"Get organization profile","deprecated":null,"version":null,"openapi":"/api-reference/earnie/platform-openapi.json get /v1/organization","href":"/earnie/api-reference/platform/organization/get-organization-profile"},{"title":"Get the organization logo","deprecated":null,"version":null,"openapi":"/api-reference/earnie/platform-openapi.json get /v1/organization/branding/logo","href":"/earnie/api-reference/platform/organization/get-the-organization-logo"},{"title":"List the scanners enabled for your organization","deprecated":null,"version":null,"openapi":"/api-reference/earnie/platform-openapi.json get /v1/organization/modules","href":"/earnie/api-reference/platform/organization/list-the-scanners-enabled-for-your-organization"},{"title":"Get the organization's pull-request controls","deprecated":null,"version":null,"openapi":"/api-reference/earnie/platform-openapi.json get /v1/organization/pr-feedback","href":"/earnie/api-reference/platform/organization/get-the-organizations-pull-request-controls"},{"title":"Replace the organization's pull-request controls","deprecated":null,"version":null,"openapi":"/api-reference/earnie/platform-openapi.json put /v1/organization/pr-feedback","href":"/earnie/api-reference/platform/organization/replace-the-organizations-pull-request-controls"},{"title":"Get the organization's Scan Configuration","deprecated":null,"version":null,"openapi":"/api-reference/earnie/platform-openapi.json get /v1/organization/scan-configuration","href":"/earnie/api-reference/platform/organization/get-the-organizations-scan-configuration"},{"title":"Replace the organization's Scan Configuration","deprecated":null,"version":null,"openapi":"/api-reference/earnie/platform-openapi.json put /v1/organization/scan-configuration","href":"/earnie/api-reference/platform/organization/replace-the-organizations-scan-configuration"},{"title":"Get a project's auto-scan-on-merge setting","deprecated":null,"version":null,"openapi":"/api-reference/earnie/platform-openapi.json get /v1/projects/{projectId}/auto-scan","href":"/earnie/api-reference/platform/organization/get-a-projects-auto-scan-on-merge-setting"},{"title":"Enable or pause a project's auto-scan-on-merge","deprecated":null,"version":null,"openapi":"/api-reference/earnie/platform-openapi.json put /v1/projects/{projectId}/auto-scan","href":"/earnie/api-reference/platform/organization/enable-or-pause-a-projects-auto-scan-on-merge"},{"title":"Get a project's pre-commit hook setting","deprecated":null,"version":null,"openapi":"/api-reference/earnie/platform-openapi.json get /v1/projects/{projectId}/hook-settings","href":"/earnie/api-reference/platform/organization/get-a-projects-pre-commit-hook-setting"},{"title":"Set a project's pre-commit hook setting","deprecated":null,"version":null,"openapi":"/api-reference/earnie/platform-openapi.json put /v1/projects/{projectId}/hook-settings","href":"/earnie/api-reference/platform/organization/set-a-projects-pre-commit-hook-setting"},{"title":"Get a project's pull-request feedback setting","deprecated":null,"version":null,"openapi":"/api-reference/earnie/platform-openapi.json get /v1/projects/{projectId}/pr-feedback","href":"/earnie/api-reference/platform/organization/get-a-projects-pull-request-feedback-setting"},{"title":"Set a project's pull-request controls","deprecated":null,"version":null,"openapi":"/api-reference/earnie/platform-openapi.json put /v1/projects/{projectId}/pr-feedback","href":"/earnie/api-reference/platform/organization/set-a-projects-pull-request-controls"},{"title":"Get a project's Scan Configuration sources","deprecated":null,"version":null,"openapi":"/api-reference/earnie/platform-openapi.json get /v1/projects/{projectId}/scan-configuration","href":"/earnie/api-reference/platform/organization/get-a-projects-scan-configuration-sources"},{"title":"Replace a project's Scan Configuration","deprecated":null,"version":null,"openapi":"/api-reference/earnie/platform-openapi.json put /v1/projects/{projectId}/scan-configuration","href":"/earnie/api-reference/platform/organization/replace-a-projects-scan-configuration"}]}]},{"group":"Integrations","pages":[{"group":"integrations","pages":[{"title":"Each connection's recorded health, and their aggregate","deprecated":null,"version":null,"openapi":"/api-reference/earnie/integrations-openapi.json get /v1/integrations/connections","href":"/earnie/api-reference/integrations/integrations/each-connections-recorded-health-and-their-aggregate"},{"title":"GitHub connection status (liveness-checked)","deprecated":null,"version":null,"openapi":"/api-reference/earnie/integrations-openapi.json get /v1/integrations/github","href":"/earnie/api-reference/integrations/integrations/github-connection-status-liveness-checked"},{"title":"List GitLab connections with what their tokens were checked to be","deprecated":null,"version":null,"openapi":"/api-reference/earnie/integrations-openapi.json get /v1/integrations/gitlab/connections","href":"/earnie/api-reference/integrations/integrations/list-gitlab-connections-with-what-their-tokens-were-checked-to-be"},{"title":"List the repositories the connections can access (live)","deprecated":null,"version":null,"openapi":"/api-reference/earnie/integrations-openapi.json get /v1/integrations/repositories","href":"/earnie/api-reference/integrations/integrations/list-the-repositories-the-connections-can-access-live"}]}]},{"group":"Components","pages":[{"group":"API Reference","pages":[{"title":"Search the SCANOSS component knowledgebase","deprecated":null,"version":null,"openapi":"/api-reference/earnie/components-openapi.json get /v1/components","href":"/earnie/api-reference/components/search-the-scanoss-component-knowledgebase"}]}]},{"group":"Audit log","pages":[{"group":"API Reference","pages":[{"title":"List instance-wide audit events","deprecated":null,"version":null,"openapi":"/api-reference/earnie/audit-openapi.json get /v1/audit-log","href":"/earnie/api-reference/audit/list-instance-wide-audit-events"},{"title":"Get one audit event","deprecated":null,"version":null,"openapi":"/api-reference/earnie/audit-openapi.json get /v1/audit-log/{eventId}","href":"/earnie/api-reference/audit/get-one-audit-event"}]}]}]}]},{"tab":"Developer Tools","hidden":false,"pages":[{"title":"Developer Tools","href":"/en/latest/developer-tools/overview"}]}]},{"version":"v1","pages":[{"title":"v1","href":"/en/latest/introduction/what-is-scanoss"}]}]},"basePath":"","title":"Run a Self-check over an inline SourceSet - SCANOSS documentation","buildId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","deploymentId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","dynamics":["10e4515597","c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["BannerMarkdown-DV3Oq1fY.js","dist-C-XZBk9h.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","clsx-D3Isdib3.js","html-void-elements-mCSPHezU.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","OpenApiReferenceProvider-CybtLBIt.js","utils-BMLj2fvV.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-B6In562Y.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dr8Mfhp9.js","snippetPresets-2rmQvMVl.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-WMqJYdZj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CJ-MlPHu.js","shallow-dY3TMRCk.js","getApiPlaygroundDisplay-v-1B2bKm.js","CodeSnippet-BDhiTB7U.js","CodeSnippets-D9hnzQcS.js","Page-C4GwDT3_.js","getPastedJson-Th2V45jI.js","icon-BQXch1W9.js","MethodPill-BCqUneP3.js","DuplicateIcon-Q_-bhurZ.js","createIcon-DUjLHRqp.js","DynamicMarkdown-B-f2cqXQ.js","SectionHeading-Da5NsV4v.js","axios-vUo_bRtp.js","Markdown-D13FWkIM.js","AssistantPageLink--qIqmmVG.js"]}