Start, stop, and check the status of the SCANOSS API service.
The SCANOSS API runs as a systemd service called scanoss-go-api.service. The installation script doesn’t start the service, so start it yourself after installation.
Start the service
sudo systemctl start scanoss-go-api.service
Stop the service
sudo systemctl stop scanoss-go-api.service
Check the service status
sudo systemctl status scanoss-go-api.service
{"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":"6b006b4ba30465d2cf4057e7","clientVersion":"0.0.4263","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":70},{"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":"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":"site-roles","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},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","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":"en/latest/installation/on-prem/configuration/api-service-management","slug":"/en/latest/installation/on-prem/configuration/api-service-management","pageMetadata":{"title":"API service management","sidebarTitle":"API service management","description":"Start, stop, and check the status of the SCANOSS API service.","href":"/en/latest/installation/on-prem/configuration/api-service-management"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Start, stop, and check the status of the SCANOSS API service.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,pre:`pre`,span:`span`,..._provideComponents(),...props.components},{CodeBlock,Heading}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`The SCANOSS API runs as a `,_jsx(_components.code,{children:`systemd`}),` service called `,_jsx(_components.code,{children:`scanoss-go-api.service`}),`. The installation script doesn’t start the service, so start it yourself after installation.`]}),`\n`,_jsx(Heading,{level:`2`,id:`start-the-service`,children:`Start the service`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`sudo`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` systemctl`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` start`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` scanoss-go-api.service`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`stop-the-service`,children:`Stop the service`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`sudo`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` systemctl`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` stop`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` scanoss-go-api.service`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`check-the-service-status`,children:`Check the service status`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`sudo`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` systemctl`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` status`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` scanoss-go-api.service`})]}),`\n`]})})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"API service management","sidebarTitle":"API service management","description":"Start, stop, and check the status of the SCANOSS API service.","href":"/en/latest/installation/on-prem/configuration/api-service-management"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Start the service","slug":"start-the-service","depth":2,"children":[]},{"title":"Stop the service","slug":"stop-the-service","depth":2,"children":[]},{"title":"Check the service status","slug":"check-the-service-status","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"scanoss","siteName":"SCANOSS documentation","title":"API service management - SCANOSS documentation","navMaps":{"firstHrefInVersion":{"v2":{"href":"/en/latest/installation/on-prem/configuration/api-service-management","matchLevel":0},"v1":{"href":"/en/latest/installation/on-prem/configuration/api-service-management","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-10-07T10:42:22.994Z","originalFileLocation":"en/latest/installation/on-prem/configuration/api-service-management.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Start, stop, and check the status of the SCANOSS API service.\">\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=\"API service management - SCANOSS documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Start, stop, and check the status of the SCANOSS API service.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"SCANOSS documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.scanoss.com/en/latest/installation/on-prem/configuration/api-service-management\">\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=Configuration\u0026amp;title=API+service+management\u0026amp;description=Start%2C+stop%2C+and+check+the+status+of+the+SCANOSS+API+service.\u0026amp;theme=27507c7cd4c9b47ed5abe8b8\u0026amp;signature=0ff97e2b1dcc5275293d1effd2996f6167621e6ad44d1c69218a9f94788276be\">\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=\"API service management - SCANOSS documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Start, stop, and check the status of the SCANOSS API service.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://scanoss.mintlify.site/_mintlify/api/og/v2?division=Configuration\u0026amp;title=API+service+management\u0026amp;description=Start%2C+stop%2C+and+check+the+status+of+the+SCANOSS+API+service.\u0026amp;theme=27507c7cd4c9b47ed5abe8b8\u0026amp;signature=0ff97e2b1dcc5275293d1effd2996f6167621e6ad44d1c69218a9f94788276be\">\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/en/latest/installation/on-prem/configuration/api-service-management\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/en/latest/installation/on-prem/configuration/api-service-management.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/en/latest/installation/on-prem/configuration/api-service-management#webpage\",\"url\":\"https://docs.scanoss.com/en/latest/installation/on-prem/configuration/api-service-management\",\"name\":\"API service management\",\"description\":\"Start, stop, and check the status of the SCANOSS API service.\",\"dateModified\":\"2026-10-07T10:42:22.994Z\",\"isPartOf\":{\"@id\":\"https://docs.scanoss.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.scanoss.com/en/latest/installation/on-prem/configuration/api-service-management#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.scanoss.com/en/latest/installation/on-prem/configuration/api-service-management#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Self-hosting \u0026 knowledge base\",\"item\":\"https://docs.scanoss.com/en/latest/core/scanoss-ldb\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"On-premises\",\"item\":\"https://docs.scanoss.com/en/latest/installation/on-prem/overview\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Deployment guide\",\"item\":\"https://docs.scanoss.com/en/latest/installation/on-prem/deployment-guide/hardware-requirements\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"API service management\",\"item\":\"https://docs.scanoss.com/en/latest/installation/on-prem/configuration/api-service-management\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.scanoss.com/en/latest/installation/on-prem/configuration/api-service-management#article\",\"headline\":\"API service management\",\"name\":\"API service management\",\"description\":\"Start, stop, and check the status of the SCANOSS API service.\",\"url\":\"https://docs.scanoss.com/en/latest/installation/on-prem/configuration/api-service-management\",\"mainEntityOfPage\":{\"@id\":\"https://docs.scanoss.com/en/latest/installation/on-prem/configuration/api-service-management#webpage\"},\"dateModified\":\"2026-10-07T10:42:22.994Z\",\"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":"/en/latest/installation/on-prem/configuration/api-service-management.md","siteName":"SCANOSS documentation","nav":{"global":null,"versions":[{"version":"v2","default":true,"tabs":[{"tab":"Earnie","hidden":false,"pages":[{"title":"Earnie","href":"/en/latest/earnie/introduction"}]},{"tab":"Developer Tools","hidden":false,"groups":[{"group":"Get started","expanded":false,"pages":[{"title":"Choose your path","sidebarTitle":"Overview","href":"/en/latest/developer-tools/overview"},{"title":"Quickstart","sidebarTitle":"Quickstart","href":"/en/latest/developer-tools/quickstart"},{"title":"API keys and authentication","sidebarTitle":"API keys and authentication","href":"/en/latest/developer-tools/authentication"}]},{"group":"Migrating to v3","expanded":false,"pages":[{"title":"Migrating to v3","sidebarTitle":"Overview","href":"/en/latest/developer-tools/migrating/overview"},{"title":"From scanoss-py to scanoss-cli","sidebarTitle":"From scanoss-py","href":"/en/latest/developer-tools/migrating/from-scanoss-py"},{"title":"Self-hosted: v2 to v3","sidebarTitle":"Self-hosted","href":"/en/latest/developer-tools/migrating/self-hosted"}]},{"group":"Recipes","expanded":false,"pages":[{"title":"Recipes","sidebarTitle":"Recipes","href":"/en/latest/developer-tools/recipes/index"},{"title":"Scan every pull request in CI","sidebarTitle":"Scan pull requests","href":"/en/latest/developer-tools/recipes/scan-pull-requests"},{"title":"Fail the build on a disallowed licence or a known vulnerability","sidebarTitle":"Licence and vulnerability gate","href":"/en/latest/developer-tools/recipes/licence-and-vulnerability-gate"},{"title":"Approve components with scanoss.json","sidebarTitle":"Approve components (BOM rules)","href":"/en/latest/developer-tools/recipes/approve-components-bom-rules"},{"title":"Local pre-commit check with scanoss-cli","sidebarTitle":"Pre-commit check","href":"/en/latest/developer-tools/recipes/pre-commit-check"},{"title":"Generate an SBOM for each release","sidebarTitle":"Release SBOM","href":"/en/latest/developer-tools/recipes/release-sbom"},{"title":"Keep an existing SBOM current","sidebarTitle":"Weekly SBOM refresh","href":"/en/latest/developer-tools/recipes/refresh-sbom-with-enrich"},{"title":"Build a cryptographic inventory (CBOM) for post-quantum readiness","sidebarTitle":"Cryptographic inventory (CBOM)","href":"/en/latest/developer-tools/recipes/crypto-inventory-cbom"},{"title":"Fingerprint-only scanning for restricted environments","sidebarTitle":"Fingerprint-only scanning","href":"/en/latest/developer-tools/recipes/fingerprint-only-scanning"}]},{"group":"CLI reference","expanded":false,"pages":[{"group":"scanoss-cli","expanded":false,"pages":[{"title":"Installation","sidebarTitle":"Installation","href":"/en/latest/cli/scanoss-go/installation"},{"title":"Quick start","sidebarTitle":"Quick start","href":"/en/latest/cli/scanoss-go/quick-start"},{"title":"Scanning your project","sidebarTitle":"Scanning your project","href":"/en/latest/cli/scanoss-go/scanning-your-project"},{"title":"Output formats","sidebarTitle":"Output formats","href":"/en/latest/cli/scanoss-go/output-formats"},{"title":"Decoration and enrichment","sidebarTitle":"Decoration and enrichment","href":"/en/latest/cli/scanoss-go/decoration-and-enrichment"},{"title":"Configuration","sidebarTitle":"Configuration","href":"/en/latest/cli/scanoss-go/configuration"},{"title":"Using Docker","sidebarTitle":"Using Docker","href":"/en/latest/cli/scanoss-go/using-docker"}]},{"group":"Crypto Finder","expanded":false,"pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/en/latest/cli/crypto-finder/overview"},{"title":"Installation","sidebarTitle":"Installation","href":"/en/latest/cli/crypto-finder/installation"},{"title":"Quick start","sidebarTitle":"Quick start","href":"/en/latest/cli/crypto-finder/quick-start"},{"title":"Configuration","sidebarTitle":"Configuration","href":"/en/latest/cli/crypto-finder/configuration"},{"title":"Output formats","sidebarTitle":"Output formats","href":"/en/latest/cli/crypto-finder/output-formats"},{"title":"Docker usage","sidebarTitle":"Docker usage","href":"/en/latest/cli/crypto-finder/docker-usage"},{"title":"Dependency scanning and call chain attribution","sidebarTitle":"Dependency scanning and call chain attribution","href":"/en/latest/cli/crypto-finder/dependency-scanning"}]}]},{"group":"API reference","expanded":false,"pages":[{"title":"v3 API overview","sidebarTitle":"v3 API overview","href":"/en/latest/developer-tools/api-overview"},{"group":"v3 endpoints","pages":[{"group":"licenses","pages":[{"title":"Attribution files (LICENSE/NOTICE/…) for one or many components","deprecated":null,"version":null,"openapi":"/api-reference/developer-tools/v3-openapi.yaml post /v3/license/attribution","href":"/developer-tools/api-reference/v3/licenses/attribution-files-licensenotice…-for-one-or-many-components"},{"title":"Per-file license evidence for one or many components","deprecated":null,"version":null,"openapi":"/api-reference/developer-tools/v3-openapi.yaml post /v3/license/evidence","href":"/developer-tools/api-reference/v3/licenses/per-file-license-evidence-for-one-or-many-components"},{"title":"Declared licenses for one component (papi License service)","deprecated":null,"version":null,"openapi":"/api-reference/developer-tools/v3-openapi.yaml get /v3/licenses","href":"/developer-tools/api-reference/v3/licenses/declared-licenses-for-one-component-papi-license-service"},{"title":"Declared licenses for many components (batch)","deprecated":null,"version":null,"openapi":"/api-reference/developer-tools/v3-openapi.yaml post /v3/licenses","href":"/developer-tools/api-reference/v3/licenses/declared-licenses-for-many-components-batch"},{"title":"SPDX registry metadata + OSADL data for a license id","deprecated":null,"version":null,"openapi":"/api-reference/developer-tools/v3-openapi.yaml get /v3/licenses/details","href":"/developer-tools/api-reference/v3/licenses/spdx-registry-metadata-+-osadl-data-for-a-license-id"},{"title":"OSADL compliance obligations for a license id","deprecated":null,"version":null,"openapi":"/api-reference/developer-tools/v3-openapi.yaml get /v3/licenses/obligations","href":"/developer-tools/api-reference/v3/licenses/osadl-compliance-obligations-for-a-license-id"}]},{"group":"copyright","pages":[{"title":"Per-file copyright evidence for one or many components","deprecated":null,"version":null,"openapi":"/api-reference/developer-tools/v3-openapi.yaml post /v3/copyright/evidence","href":"/developer-tools/api-reference/v3/copyright/per-file-copyright-evidence-for-one-or-many-components"},{"title":"Distinct copyright holders for one or many components","deprecated":null,"version":null,"openapi":"/api-reference/developer-tools/v3-openapi.yaml post /v3/copyright/holders","href":"/developer-tools/api-reference/v3/copyright/distinct-copyright-holders-for-one-or-many-components"}]},{"group":"components","pages":[{"title":"Search components by free term, vendor, component or both","deprecated":null,"version":null,"openapi":"/api-reference/developer-tools/v3-openapi.yaml get /v3/components/search","href":"/developer-tools/api-reference/v3/components/search-components-by-free-term-vendor-component-or-both"},{"title":"List versions (with licenses) for a given purl","deprecated":null,"version":null,"openapi":"/api-reference/developer-tools/v3-openapi.yaml get /v3/components/versions","href":"/developer-tools/api-reference/v3/components/list-versions-with-licenses-for-a-given-purl"},{"title":"Resolve lifecycle status for a single purl","deprecated":null,"version":null,"openapi":"/api-reference/developer-tools/v3-openapi.yaml get /v3/components/status","href":"/developer-tools/api-reference/v3/components/resolve-lifecycle-status-for-a-single-purl"},{"title":"Resolve lifecycle status for many purls in one call","deprecated":null,"version":null,"openapi":"/api-reference/developer-tools/v3-openapi.yaml post /v3/components/status","href":"/developer-tools/api-reference/v3/components/resolve-lifecycle-status-for-many-purls-in-one-call"},{"title":"Release notes / changelog for a component","deprecated":null,"version":null,"openapi":"/api-reference/developer-tools/v3-openapi.yaml get /v3/components/releases","href":"/developer-tools/api-reference/v3/components/release-notes-changelog-for-a-component"},{"title":"Release notes for many purls in one call (SBOM use case)","deprecated":null,"version":null,"openapi":"/api-reference/developer-tools/v3-openapi.yaml post /v3/components/releases","href":"/developer-tools/api-reference/v3/components/release-notes-for-many-purls-in-one-call-sbom-use-case"}]},{"group":"cryptography","pages":[{"title":"Cryptographic algorithms detected at one (resolved) version of a component","deprecated":null,"version":null,"openapi":"/api-reference/developer-tools/v3-openapi.yaml get /v3/cryptography/algorithms","href":"/developer-tools/api-reference/v3/cryptography/cryptographic-algorithms-detected-at-one-resolved-version-of-a-component"},{"title":"Cryptographic algorithms for many components","deprecated":null,"version":null,"openapi":"/api-reference/developer-tools/v3-openapi.yaml post /v3/cryptography/algorithms","href":"/developer-tools/api-reference/v3/cryptography/cryptographic-algorithms-for-many-components"},{"title":"Algorithms detected across every version satisfying a semver range","deprecated":null,"version":null,"openapi":"/api-reference/developer-tools/v3-openapi.yaml get /v3/cryptography/algorithms/range","href":"/developer-tools/api-reference/v3/cryptography/algorithms-detected-across-every-version-satisfying-a-semver-range"},{"title":"Algorithms in range, batch","deprecated":null,"version":null,"openapi":"/api-reference/developer-tools/v3-openapi.yaml post /v3/cryptography/algorithms/range","href":"/developer-tools/api-reference/v3/cryptography/algorithms-in-range-batch"},{"title":"Partition versions in a semver range into those with and without crypto","deprecated":null,"version":null,"openapi":"/api-reference/developer-tools/v3-openapi.yaml get /v3/cryptography/algorithms/versions/range","href":"/developer-tools/api-reference/v3/cryptography/partition-versions-in-a-semver-range-into-those-with-and-without-crypto"},{"title":"Versions in range, batch","deprecated":null,"version":null,"openapi":"/api-reference/developer-tools/v3-openapi.yaml post /v3/cryptography/algorithms/versions/range","href":"/developer-tools/api-reference/v3/cryptography/versions-in-range-batch"},{"title":"Crypto library hints (SDKs/protocols/libraries) at one resolved version","deprecated":null,"version":null,"openapi":"/api-reference/developer-tools/v3-openapi.yaml get /v3/cryptography/hints","href":"/developer-tools/api-reference/v3/cryptography/crypto-library-hints-sdksprotocolslibraries-at-one-resolved-version"},{"title":"Crypto hints, batch","deprecated":null,"version":null,"openapi":"/api-reference/developer-tools/v3-openapi.yaml post /v3/cryptography/hints","href":"/developer-tools/api-reference/v3/cryptography/crypto-hints-batch"},{"title":"Crypto hints across every version satisfying a semver range","deprecated":null,"version":null,"openapi":"/api-reference/developer-tools/v3-openapi.yaml get /v3/cryptography/hints/range","href":"/developer-tools/api-reference/v3/cryptography/crypto-hints-across-every-version-satisfying-a-semver-range"},{"title":"Crypto hints in range, batch","deprecated":null,"version":null,"openapi":"/api-reference/developer-tools/v3-openapi.yaml post /v3/cryptography/hints/range","href":"/developer-tools/api-reference/v3/cryptography/crypto-hints-in-range-batch"},{"title":"Download a ruleset tarball","deprecated":null,"version":null,"openapi":"/api-reference/developer-tools/v3-openapi.yaml get /v3/cryptography/rulesets/{ruleset_name}/{version}/download","href":"/developer-tools/api-reference/v3/cryptography/download-a-ruleset-tarball"}]},{"group":"dependencies","pages":[{"title":"Resolve declared dependencies + licenses for one purl","deprecated":null,"version":null,"openapi":"/api-reference/developer-tools/v3-openapi.yaml get /v3/dependencies/dependencies","href":"/developer-tools/api-reference/v3/dependencies/resolve-declared-dependencies-+-licenses-for-one-purl"},{"title":"Resolve declared dependencies for many purls","deprecated":null,"version":null,"openapi":"/api-reference/developer-tools/v3-openapi.yaml post /v3/dependencies/dependencies","href":"/developer-tools/api-reference/v3/dependencies/resolve-declared-dependencies-for-many-purls"},{"title":"Walk declared dependencies bounded by depth and limit","deprecated":null,"version":null,"openapi":"/api-reference/developer-tools/v3-openapi.yaml post /v3/dependencies/transitive","href":"/developer-tools/api-reference/v3/dependencies/walk-declared-dependencies-bounded-by-depth-and-limit"}]},{"group":"geoprovenance","pages":[{"title":"Declared + curated contributor locations for a single purl","deprecated":null,"version":null,"openapi":"/api-reference/developer-tools/v3-openapi.yaml get /v3/geoprovenance/countries","href":"/developer-tools/api-reference/v3/geoprovenance/declared-+-curated-contributor-locations-for-a-single-purl"},{"title":"Declared + curated contributor locations for many purls","deprecated":null,"version":null,"openapi":"/api-reference/developer-tools/v3-openapi.yaml post /v3/geoprovenance/countries","href":"/developer-tools/api-reference/v3/geoprovenance/declared-+-curated-contributor-locations-for-many-purls"},{"title":"Contributor origin distribution by timezone-based country","deprecated":null,"version":null,"openapi":"/api-reference/developer-tools/v3-openapi.yaml get /v3/geoprovenance/origin","href":"/developer-tools/api-reference/v3/geoprovenance/contributor-origin-distribution-by-timezone-based-country"},{"title":"Contributor origin distribution for many purls","deprecated":null,"version":null,"openapi":"/api-reference/developer-tools/v3-openapi.yaml post /v3/geoprovenance/origin","href":"/developer-tools/api-reference/v3/geoprovenance/contributor-origin-distribution-for-many-purls"}]},{"group":"vulnerabilities","pages":[{"title":"CPEs detected for a single (purl, requirement)","deprecated":null,"version":null,"openapi":"/api-reference/developer-tools/v3-openapi.yaml get /v3/vulnerabilities/cpes","href":"/developer-tools/api-reference/v3/vulnerabilities/cpes-detected-for-a-single-purl-requirement"},{"title":"CPEs for many components","deprecated":null,"version":null,"openapi":"/api-reference/developer-tools/v3-openapi.yaml post /v3/vulnerabilities/cpes","href":"/developer-tools/api-reference/v3/vulnerabilities/cpes-for-many-components"},{"title":"Vulnerabilities for a single (purl, requirement)","deprecated":null,"version":null,"openapi":"/api-reference/developer-tools/v3-openapi.yaml get /v3/vulnerabilities/vulnerabilities","href":"/developer-tools/api-reference/v3/vulnerabilities/vulnerabilities-for-a-single-purl-requirement"},{"title":"Vulnerabilities for many components","deprecated":null,"version":null,"openapi":"/api-reference/developer-tools/v3-openapi.yaml post /v3/vulnerabilities/vulnerabilities","href":"/developer-tools/api-reference/v3/vulnerabilities/vulnerabilities-for-many-components"}]},{"group":"contents","pages":[{"title":"Fetch the raw text of a notice from the mz store","deprecated":null,"version":null,"openapi":"/api-reference/developer-tools/v3-openapi.yaml get /v3/notice-contents/{id}","href":"/developer-tools/api-reference/v3/contents/fetch-the-raw-text-of-a-notice-from-the-mz-store"},{"title":"Fetch the raw text of a source file from the mz store","deprecated":null,"version":null,"openapi":"/api-reference/developer-tools/v3-openapi.yaml get /v3/file-contents/{id}","href":"/developer-tools/api-reference/v3/contents/fetch-the-raw-text-of-a-source-file-from-the-mz-store"},{"title":"Fetch the raw text of a metadata fragment from the mz store","deprecated":null,"version":null,"openapi":"/api-reference/developer-tools/v3-openapi.yaml get /v3/metadata-contents/{id}","href":"/developer-tools/api-reference/v3/contents/fetch-the-raw-text-of-a-metadata-fragment-from-the-mz-store"}]},{"group":"cryptography-reachability","pages":[{"title":"Reachability for a component stitched across its declared dep tree.","deprecated":null,"version":null,"openapi":"/api-reference/developer-tools/v3-openapi.yaml post /v3/cryptography/reachability/component","href":"/developer-tools/api-reference/v3/cryptography-reachability/reachability-for-a-component-stitched-across-its-declared-dep-tree"},{"title":"Reachability for a caller-supplied frozen dependency tree.","deprecated":null,"version":null,"openapi":"/api-reference/developer-tools/v3-openapi.yaml post /v3/cryptography/reachability/dep-tree","href":"/developer-tools/api-reference/v3/cryptography-reachability/reachability-for-a-caller-supplied-frozen-dependency-tree"}]},{"group":"scan","pages":[{"title":"Scan an uploaded WFP / source archive (synchronous)","deprecated":null,"version":null,"openapi":"/api-reference/developer-tools/v3-openapi.yaml post /v3/wfp/scan/direct","href":"/developer-tools/api-reference/v3/scan/scan-an-uploaded-wfp-source-archive-synchronous"},{"title":"Scan a WFP — synchronous single-shot, or one block of a chunked async upload","deprecated":null,"version":null,"openapi":"/api-reference/developer-tools/v3-openapi.yaml post /v3/wfp/scan","href":"/developer-tools/api-reference/v3/scan/scan-a-wfp-—-synchronous-single-shot-or-one-block-of-a-chunked-async-upload"},{"title":"Poll progress / result of an async (Mode A) batch scan","deprecated":null,"version":null,"openapi":"/api-reference/developer-tools/v3-openapi.yaml get /v3/wfp/scan/{id}","href":"/developer-tools/api-reference/v3/scan/poll-progress-result-of-an-async-mode-a-batch-scan"},{"title":"Components for a file MD5","deprecated":null,"version":null,"openapi":"/api-reference/developer-tools/v3-openapi.yaml get /v3/raw/scan","href":"/developer-tools/api-reference/v3/scan/components-for-a-file-md5"},{"title":"Match a raw WFP body (snippets)","deprecated":null,"version":null,"openapi":"/api-reference/developer-tools/v3-openapi.yaml post /v3/snippets/scan","href":"/developer-tools/api-reference/v3/scan/match-a-raw-wfp-body-snippets"},{"title":"Components for one or more urlhashes","deprecated":null,"version":null,"openapi":"/api-reference/developer-tools/v3-openapi.yaml post /v3/components/scan","href":"/developer-tools/api-reference/v3/scan/components-for-one-or-more-urlhashes"}]}]}]},{"group":"Self-hosting \u0026 knowledge base","expanded":false,"pages":[{"title":"SCANOSS LDB","sidebarTitle":"SCANOSS LDB","href":"/en/latest/core/scanoss-ldb"},{"group":"SCANOSS engine","expanded":false,"pages":[{"title":"Scanning a file or directory","sidebarTitle":"Scanning a file or directory","href":"/en/latest/core/engine/scanning-file-or-directory"},{"title":"Command parameters and flags","sidebarTitle":"Command parameters and flags","href":"/en/latest/core/engine/command-parameters-flags"}]},{"group":"On-premises","expanded":false,"pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/en/latest/installation/on-prem/overview"},{"group":"Deployment guide","expanded":false,"pages":[{"title":"Hardware requirements","sidebarTitle":"Hardware requirements","href":"/en/latest/installation/on-prem/deployment-guide/hardware-requirements"},{"title":"Prepare the environment","sidebarTitle":"Prepare the environment","href":"/en/latest/installation/on-prem/deployment-guide/prepare-environment"},{"title":"Install applications","sidebarTitle":"Install applications","href":"/en/latest/installation/on-prem/deployment-guide/install-applications"},{"title":"Install Knowledge Base","sidebarTitle":"Install Knowledge Base","href":"/en/latest/installation/on-prem/deployment-guide/install-knowledge-base"},{"title":"Verify installation","sidebarTitle":"Verify installation","description":"Check that each SCANOSS component works after installation.","href":"/en/latest/installation/on-prem/deployment-guide/verify-installation"},{"group":"Configuration","expanded":false,"pages":[{"title":"API service management","sidebarTitle":"API service management","href":"/en/latest/installation/on-prem/configuration/api-service-management"},{"title":"API configuration","sidebarTitle":"API configuration","description":"Configure the SCANOSS API service with the application configuration file.","href":"/en/latest/installation/on-prem/configuration/api-configuration"}]}]},{"title":"KB update guide","sidebarTitle":"KB update guide","href":"/en/latest/installation/on-prem/kb-update-guide"},{"title":"KB Docker example","href":"/en/latest/installation/on-prem/local-kb-docker-example"}]},{"title":"Cloud deployment","sidebarTitle":"Cloud deployment","href":"/en/latest/installation/cloud-deployment"}]}]}]},{"version":"v1","tabs":[{"tab":"Guides","hidden":false,"groups":[{"group":"Introduction \u0026 Overview","expanded":false,"pages":[{"title":"What is SCANOSS?","href":"/en/latest/introduction/what-is-scanoss"},{"group":"Core Use Cases","expanded":false,"pages":[{"title":"Open Source in AI-Generated Code","sidebarTitle":"Open Source in AI-Generated Code","href":"/en/latest/introduction/use-cases/oss-in-ai-gen-code"},{"title":"Cryptography Detection","sidebarTitle":"Cryptography Detection","href":"/en/latest/introduction/use-cases/crypto-detection"},{"title":"OSS Licence Compliance","sidebarTitle":"OSS Licence Compliance","href":"/en/latest/introduction/use-cases/oss-license-compliance"}]},{"title":"Platform Architecture Overview","href":"/en/latest/introduction/platform-architecture-overview"},{"title":"Initial API Configuration","sidebarTitle":"Initial API Configuration","href":"/en/latest/introduction/initial-api-configuration"}]},{"group":"Getting Started","expanded":false,"pages":[{"title":"Components Overview","sidebarTitle":"Components Overview","href":"/en/latest/getting-started/components-overview"},{"title":"Understanding Scan Results","sidebarTitle":"Understanding Scan Results","href":"/en/latest/getting-started/understanding-scan-results"},{"title":"Declaring Components","sidebarTitle":"Declaring Components","href":"/en/latest/getting-started/declaring-components"}]},{"group":"Installation \u0026 Deployment","expanded":false,"pages":[{"group":"On-Premise","expanded":false,"pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/en/latest/installation/on-prem/overview"},{"group":"Deployment Guide","expanded":false,"pages":[{"title":"Hardware requirements","sidebarTitle":"Hardware requirements","href":"/en/latest/installation/on-prem/deployment-guide/hardware-requirements"},{"title":"Prepare the environment","sidebarTitle":"Prepare the environment","href":"/en/latest/installation/on-prem/deployment-guide/prepare-environment"},{"title":"Install applications","sidebarTitle":"Install applications","href":"/en/latest/installation/on-prem/deployment-guide/install-applications"},{"title":"Install Knowledge Base","sidebarTitle":"Install Knowledge Base","href":"/en/latest/installation/on-prem/deployment-guide/install-knowledge-base"},{"title":"Verify installation","sidebarTitle":"Verify installation","description":"Check that each SCANOSS component works after installation.","href":"/en/latest/installation/on-prem/deployment-guide/verify-installation"},{"group":"Configuration","expanded":false,"pages":[{"title":"API service management","sidebarTitle":"API service management","href":"/en/latest/installation/on-prem/configuration/api-service-management"},{"title":"API configuration","sidebarTitle":"API configuration","description":"Configure the SCANOSS API service with the application configuration file.","href":"/en/latest/installation/on-prem/configuration/api-configuration"}]}]},{"title":"KB update guide","sidebarTitle":"KB update guide","href":"/en/latest/installation/on-prem/kb-update-guide"},{"title":"KB Docker example","href":"/en/latest/installation/on-prem/local-kb-docker-example"}]},{"title":"Cloud deployment","sidebarTitle":"Cloud deployment","href":"/en/latest/installation/cloud-deployment"}]},{"group":"Configuration \u0026 Administration","expanded":false,"pages":[{"title":"Proxy Configuration","sidebarTitle":"Proxy Configuration","href":"/en/latest/configuration/proxy-configuration"},{"title":"Certificate Management","sidebarTitle":"Certificate Management","href":"/en/latest/configuration/certificate-management"}]},{"group":"Integrations \u0026 CI/CD","expanded":false,"pages":[{"title":"Pre-Commit Hooks","sidebarTitle":"Pre-Commit Hooks","href":"/en/latest/integrations/pre-commit-hooks"},{"title":"GitHub Actions","sidebarTitle":"GitHub Actions","href":"/en/latest/integrations/github-actions"},{"title":"Azure DevOps","sidebarTitle":"Azure DevOps","href":"/en/latest/integrations/azure-devops"},{"title":"Jenkins","sidebarTitle":"Jenkins","href":"/en/latest/integrations/jenkins"},{"title":"GitLab","sidebarTitle":"GitLab","href":"/en/latest/integrations/gitlab"},{"title":"SonarQube","sidebarTitle":"SonarQube","href":"/en/latest/integrations/sonarqube"},{"title":"Dependency-Track","sidebarTitle":"Dependency-Track","href":"/en/latest/integrations/dependency-track"},{"title":"OSS Review Toolkit (ORT)","sidebarTitle":"OSS Review Toolkit (ORT)","href":"/en/latest/integrations/oss-review-toolkit"}]},{"group":"Engine \u0026 LDB","expanded":false,"pages":[{"group":"SCANOSS Engine","expanded":false,"pages":[{"title":"Scanning a file or directory","sidebarTitle":"Scanning a file or directory","href":"/en/latest/core/engine/scanning-file-or-directory"},{"title":"Command parameters and flags","sidebarTitle":"Command parameters and flags","href":"/en/latest/core/engine/command-parameters-flags"}]},{"title":"SCANOSS LDB","sidebarTitle":"SCANOSS LDB","href":"/en/latest/core/scanoss-ldb"}]},{"group":"CLI Tools","expanded":false,"pages":[{"group":"SCANOSS-PY","expanded":false,"pages":[{"title":"Installation","sidebarTitle":"Installation","href":"/en/latest/cli/scanoss-py/installation"},{"title":"Scanning Your Project","sidebarTitle":"Scanning","href":"/en/latest/cli/scanoss-py/scanning-your-project"},{"title":"Output Formats","sidebarTitle":"Output Formats","href":"/en/latest/cli/scanoss-py/output-formats"},{"title":"Converting Results","sidebarTitle":"Converting Results","href":"/en/latest/cli/scanoss-py/converting-results"},{"title":"Commands \u0026 Arguments","sidebarTitle":"Commands \u0026 Arguments","href":"/en/latest/cli/scanoss-py/commands-and-arguments"},{"title":"Proxy and Certificate Options","sidebarTitle":"Proxy and Certificate Options","href":"/en/latest/cli/scanoss-py/proxy-and-certificate-options"},{"title":"Using Docker","sidebarTitle":"Using Docker","href":"/en/latest/cli/scanoss-py/using-docker"},{"title":"Advanced Use","sidebarTitle":"Advanced Use","href":"/en/latest/cli/scanoss-py/advanced-use"}]},{"group":"SCANOSS-JS","expanded":false,"pages":[{"title":"Installation","sidebarTitle":"Installation","href":"/en/latest/cli/scanoss-js/installation"},{"title":"Scanning and Fingerprinting Examples","sidebarTitle":"Scanning and Fingerprinting Examples","href":"/en/latest/cli/scanoss-js/scanning-and-fingerprinting-examples"},{"title":"Commands \u0026 Arguments","sidebarTitle":"Commands \u0026 Arguments","href":"/en/latest/cli/scanoss-js/commands-and-arguments"}]},{"group":"Crypto Finder","expanded":false,"pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/en/latest/cli/crypto-finder/overview"},{"title":"Installation","sidebarTitle":"Installation","href":"/en/latest/cli/crypto-finder/installation"},{"title":"Quick start","sidebarTitle":"Quick start","href":"/en/latest/cli/crypto-finder/quick-start"},{"title":"Configuration","sidebarTitle":"Configuration","href":"/en/latest/cli/crypto-finder/configuration"},{"title":"Output formats","sidebarTitle":"Output formats","href":"/en/latest/cli/crypto-finder/output-formats"},{"title":"Docker usage","sidebarTitle":"Docker usage","href":"/en/latest/cli/crypto-finder/docker-usage"},{"title":"Dependency scanning and call chain attribution","sidebarTitle":"Dependency scanning and call chain attribution","href":"/en/latest/cli/crypto-finder/dependency-scanning"}]}]},{"group":"SDKs","expanded":false,"pages":[{"group":"Python SDK","expanded":false,"pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/en/latest/sdks/python/overview"},{"title":"Authentication","sidebarTitle":"Authentication","href":"/en/latest/sdks/python/authentication"},{"title":"Usage","sidebarTitle":"Usage","href":"/en/latest/sdks/python/usage"}]},{"group":"Java SDK","expanded":false,"pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/en/latest/sdks/java/overview"},{"title":"Authentication","sidebarTitle":"Authentication","href":"/en/latest/sdks/java/authentication"},{"title":"Usage","sidebarTitle":"Usage","href":"/en/latest/sdks/java/usage"}]},{"group":"JavaScript SDK","expanded":false,"pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/en/latest/sdks/javascript/overview"},{"title":"Authentication","sidebarTitle":"Authentication","href":"/en/latest/sdks/javascript/authentication"},{"title":"Usage","sidebarTitle":"Usage","href":"/en/latest/sdks/javascript/usage"}]}]},{"group":"Clients / Tools","expanded":false,"pages":[{"group":"SBOM Workbench","expanded":false,"pages":[{"title":"Installation \u0026 Setup","sidebarTitle":"Installation \u0026 Setup","href":"/en/latest/clients/workbench/installation-quick-start"},{"title":"Scanning, Reporting and Auditing","sidebarTitle":"Scanning, Reporting and Auditing","href":"/en/latest/clients/workbench/project-scanning-auditing-reporting"},{"title":"Advanced Search \u0026 Final Review","sidebarTitle":"Advanced Search \u0026 Final Review","href":"/en/latest/clients/workbench/vulnerability-crypto-scanning"},{"title":"Exporting SBOMs and Projects","sidebarTitle":"Exporting SBOMs and Projects","href":"/en/latest/clients/workbench/metadata-export-import"}]},{"title":"SCANOSS-CC","sidebarTitle":"SCANOSS-CC","href":"/en/latest/clients/code-compare"}]},{"group":"APIs and Services","expanded":false,"pages":[{"title":"API Overview","sidebarTitle":"API Overview","href":"/en/latest/apis/api-overview"},{"title":"Cryptography API","sidebarTitle":"Cryptography API","href":"/en/latest/apis/encryption-api"},{"title":"Vulnerability API","sidebarTitle":"Vulnerability API","href":"/en/latest/apis/vulnerability-api"},{"title":"Component Search API","sidebarTitle":"Component Search API","href":"/en/latest/apis/component-search-api"},{"title":"License API","sidebarTitle":"License API","href":"/en/latest/apis/license-api"},{"title":"Geoprovenance API","sidebarTitle":"Geoprovenance API","href":"/en/latest/apis/geoprovenance-api"},{"title":"Dependencies API","sidebarTitle":"Dependencies API","href":"/en/latest/apis/dependencies-api"},{"title":"Scanning API","sidebarTitle":"Scanning API","href":"/en/latest/apis/scanning-api"},{"group":"Postman Setup","expanded":false,"pages":[{"title":"Workspace Setup","sidebarTitle":"Workspace Setup","href":"/en/latest/apis/postman/workspace-setup"},{"title":"Sending Requests and Reviewing Results","sidebarTitle":"Sending Requests and Reviewing Results","href":"/en/latest/apis/postman/sending-requests-reviewing-results"}]}]},{"group":"Advanced Topics","expanded":false,"pages":[{"title":"SBOM Formats","sidebarTitle":"SBOM Formats","href":"/en/latest/advanced/sbom-formats"},{"title":"Fast Winnowing \u0026 Fingerprinting","sidebarTitle":"Fast Winnowing \u0026 Fingerprinting","href":"/en/latest/advanced/fast-winnowing-fingerprint-algorithms"}]},{"group":"Release Notes \u0026 References","expanded":false,"pages":[{"title":"Changelog / Version History","sidebarTitle":"Changelog / Version History","href":"/en/latest/release-notes/changelog-version-history"},{"title":"References and External Docs","sidebarTitle":"References and External Docs","href":"/en/latest/release-notes/references-external-docs"}]},{"group":"Help \u0026 Support","expanded":false,"pages":[{"title":"Troubleshooting \u0026 FAQs","sidebarTitle":"Troubleshooting \u0026 FAQs","href":"/en/latest/troubleshooting-and-faqs"},{"title":"Support \u0026 Contribution","sidebarTitle":"Support \u0026 Contribution","href":"/en/latest/support-and-contribution"}]},{"group":"Links","public":true,"pages":[{"sidebarTitle":"SCANOSS Website","url":"https://www.scanoss.com/","title":null,"href":"/link/web"},{"sidebarTitle":"GitHub","url":"https://github.com/scanoss","title":null,"href":"/link/github"},{"sidebarTitle":"Youtube","url":"https://www.youtube.com/@SCANOSS","title":null,"href":"/link/youtube"}]}]},{"tab":"PoC","hidden":false,"pages":[{"title":"PoC","href":"/en/latest/poc/evaluation/introduction"}]}]}]},"basePath":"","title":"API service management - SCANOSS documentation","deploymentId":"dpl_7AgmPo2RyRWZ68ZGceW618SWGEAz","buildId":"dpl_7AgmPo2RyRWZ68ZGceW618SWGEAz","dynamics":["10e4515597"],"chunks":["BannerMarkdown-Cc6DT3k_.js","dist-BbIWfytJ.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}