{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"OASM","colors":{"primary":"#059BFD","light":"#59C4FD","dark":"#047DD1"},"logo":"https://mintcdn.com/oasmplatform/EA9X9n_Tn9AWO8GU/logo/oasm-logo.png?fit=max\u0026auto=format\u0026n=EA9X9n_Tn9AWO8GU\u0026q=85\u0026s=24a2400cb969b09bb5776f8baaf45987","favicon":"https://mintcdn.com/oasmplatform/EA9X9n_Tn9AWO8GU/favicon.ico?fit=max\u0026auto=format\u0026n=EA9X9n_Tn9AWO8GU\u0026q=85\u0026s=4ffd59fa0999d5ddd805cfa394871c58","api":{"playground":{"display":"interactive"},"examples":{"defaults":"required","languages":["curl","python","javascript","go"],"prefill":true,"autogenerate":true}},"appearance":{"default":"system","strict":false},"background":{"decoration":"gradient"},"navbar":{"links":[{"href":"mailto:[email protected]","label":"Support"}]},"footer":{"socials":{"github":"https://github.com/oasm-platform","linkedin":"https://www.linkedin.com/company/oasm-platform","x":"https://x.com/OasmPlatform"}},"seo":{"indexing":"all"},"icons":{"library":"lucide"},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"oasmplatform","hasAudioNarration":false,"actualSubdomain":"oasmplatform","customDomains":["docs.oasm.dev"],"gitSource":{"type":"github","owner":"oasm-platform","repo":"mintlify-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ad465c1071396a1f3398aa6","collectionId":"f514a1cd-7c75-44a2-b330-3ab579d419d3","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ad465c1071396a1f3398aa6"},"entitlements":{},"buildId":"6ad465c1071396a1f3398aa6","clientVersion":"0.0.3926","searchFilterCounts":[{"language":"default","tag":"API Reference","count":176},{"language":"default","tag":"Documentation","count":34},{"language":"default","tag":"Agents","count":28},{"language":"default","tag":"Integrations","count":19},{"language":"default","tag":"Asset Group","count":15},{"language":"default","tag":"Assets","count":12},{"language":"default","tag":"Tools","count":10},{"language":"default","tag":"Workspaces","count":10},{"language":"default","tag":"JobsRegistry","count":9},{"language":"default","tag":"Notifications","count":8}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/workspaces/get-workspace-api-key","slug":"/api-reference/workspaces/get-workspace-api-key","pageMetadata":{"title":"Get workspace API key","description":"Retrieves the authentication API key for secure access to the specified workspace, enabling programmatic interactions with workspace resources.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/workspaces/api-key","href":"/api-reference/workspaces/get-workspace-api-key","autogeneratedByOpenApi":true},"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: \"Retrieves the authentication API key for secure access to the specified workspace, enabling programmatic interactions with workspace resources.\"\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":"Get workspace API key","description":"Retrieves the authentication API key for secure access to the specified workspace, enabling programmatic interactions with workspace resources.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/workspaces/api-key","href":"/api-reference/workspaces/get-workspace-api-key","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"Retrieves the authentication API key for secure access to the specified workspace, enabling programmatic interactions with workspace resources.","operationId":"WorkspacesController_getWorkspaceApiKey","parameters":["67b2b808-c44b-45df-87bf-647d66b91a18"],"responses":{"200":"403f84fd-86f9-49ce-a7ce-ae5387dc3331"},"summary":"Get workspace API key","tags":["Workspaces"],"method":"get","type":"path","servers":["e13367d6-85ac-4089-9444-77641a4b3fb9"],"security":[],"path":"/api/workspaces/api-key","baseUrlOptions":["https://{baseUrl}/api/v1"],"title":"Get workspace API key","codeSamples":[],"requestExampleLanguages":["bash","python","javascript","go"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[]},"dependencies":{"parameters":{"67b2b808-c44b-45df-87bf-647d66b91a18":{"name":"X-Workspace-Id","in":"header","description":"Workspace ID","schema":{"type":"string","description":"Workspace ID","uniqueKey":"","typeLabel":"string"}}},"responses":{"403f84fd-86f9-49ce-a7ce-ae5387dc3331":{"description":"","content":{"application/json":{"schema":{"type":"object","required":["apiKey"],"properties":{"apiKey":{"type":"string","isRequired":true,"uniqueKey":"apiKey","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"apiKey":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{},"servers":{"e13367d6-85ac-4089-9444-77641a4b3fb9":{"url":"https://{baseUrl}/api/v1","variables":{"baseUrl":{"default":"localhost:3000","description":"API server hostname with port (e.g. localhost:3000, api.example.com)"}}}}},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"oasmplatform","siteName":"OASM","title":"Get workspace API key - OASM","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-07-23T10:30:03.786Z","originalFileLocation":"api-reference/workspaces/get-workspace-api-key.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=\"Retrieves the authentication API key for secure access to the specified workspace, enabling programmatic interactions with workspace resources.\">\u003cmeta data-mint-head name=\"application-name\" content=\"OASM\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/oasmplatform/-dBudSijFretNRGA/_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/oasmplatform/-dBudSijFretNRGA/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/oasmplatform/-dBudSijFretNRGA/_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/oasmplatform/-dBudSijFretNRGA/_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/oasmplatform/-dBudSijFretNRGA/_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/oasmplatform/-dBudSijFretNRGA/_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/oasmplatform/-dBudSijFretNRGA/_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/oasmplatform/-dBudSijFretNRGA/_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/oasmplatform/-dBudSijFretNRGA/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get workspace API key - OASM\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieves the authentication API key for secure access to the specified workspace, enabling programmatic interactions with workspace resources.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"OASM\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.oasm.dev/api-reference/workspaces/get-workspace-api-key\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://oasmplatform.mintlify.app/_mintlify/api/og/v2?division=Workspaces\u0026amp;title=Get+workspace+API+key\u0026amp;description=Retrieves+the+authentication+API+key+for+secure+access+to+the+specified+workspace%2C+enabling+programmatic+interactions+with+workspace+resources.\u0026amp;theme=df6f8c81a61a2a78a13b177b\u0026amp;signature=446b36c4e1e1a05cfe76d833b5339c9ce7cc9613e35dc93229077ea47f852858\">\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=\"Get workspace API key - OASM\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieves the authentication API key for secure access to the specified workspace, enabling programmatic interactions with workspace resources.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://oasmplatform.mintlify.app/_mintlify/api/og/v2?division=Workspaces\u0026amp;title=Get+workspace+API+key\u0026amp;description=Retrieves+the+authentication+API+key+for+secure+access+to+the+specified+workspace%2C+enabling+programmatic+interactions+with+workspace+resources.\u0026amp;theme=df6f8c81a61a2a78a13b177b\u0026amp;signature=446b36c4e1e1a05cfe76d833b5339c9ce7cc9613e35dc93229077ea47f852858\">\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/oasmplatform/-dBudSijFretNRGA/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"OASM\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#059BFD\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.oasm.dev/api-reference/workspaces/get-workspace-api-key\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/workspaces/get-workspace-api-key.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.oasm.dev/#organization\",\"name\":\"OASM\",\"url\":\"https://docs.oasm.dev\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/oasmplatform/EA9X9n_Tn9AWO8GU/logo/oasm-logo.png?fit=max\u0026auto=format\u0026n=EA9X9n_Tn9AWO8GU\u0026q=85\u0026s=24a2400cb969b09bb5776f8baaf45987\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.oasm.dev#website\",\"name\":\"OASM\",\"url\":\"https://docs.oasm.dev\",\"publisher\":{\"@id\":\"https://docs.oasm.dev/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.oasm.dev/api-reference/workspaces/get-workspace-api-key#webpage\",\"url\":\"https://docs.oasm.dev/api-reference/workspaces/get-workspace-api-key\",\"name\":\"Get workspace API key\",\"description\":\"Retrieves the authentication API key for secure access to the specified workspace, enabling programmatic interactions with workspace resources.\",\"dateModified\":\"2026-07-23T10:30:03.786Z\",\"isPartOf\":{\"@id\":\"https://docs.oasm.dev#website\"},\"breadcrumb\":{\"@id\":\"https://docs.oasm.dev/api-reference/workspaces/get-workspace-api-key#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.oasm.dev/api-reference/workspaces/get-workspace-api-key#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Workspaces\",\"item\":\"https://docs.oasm.dev/api-reference/workspaces/get-workspaces\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get workspace API key\",\"item\":\"https://docs.oasm.dev/api-reference/workspaces/get-workspace-api-key\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.oasm.dev/api-reference/workspaces/get-workspace-api-key#apireference\",\"headline\":\"Get workspace API key\",\"name\":\"Get workspace API key\",\"description\":\"Retrieves the authentication API key for secure access to the specified workspace, enabling programmatic interactions with workspace resources.\",\"url\":\"https://docs.oasm.dev/api-reference/workspaces/get-workspace-api-key\",\"mainEntityOfPage\":{\"@id\":\"https://docs.oasm.dev/api-reference/workspaces/get-workspace-api-key#webpage\"},\"dateModified\":\"2026-07-23T10:30:03.786Z\",\"publisher\":{\"@id\":\"https://docs.oasm.dev/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.oasm.dev#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"OASM\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"OASM","nav":{"global":null,"tabs":[{"tab":"Documentation","icon":"book-open","pages":[{"title":"Documentation","href":""}]},{"tab":"Development","icon":"code","pages":[{"title":"Development","href":"/developer-guide"}]},{"tab":"Connectors","icon":"puzzle","pages":[{"title":"Connectors","href":"/connectors/overview"}]},{"tab":"API Reference","icon":"terminal","groups":[{"group":"Targets","pages":[{"title":"Create multiple targets in bulk","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/targets/bulk","href":"/api-reference/targets/create-multiple-targets-in-bulk"},{"title":"Get all targets in a workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/targets","href":"/api-reference/targets/get-all-targets-in-a-workspace"},{"title":"Export targets to CSV","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/targets/export","href":"/api-reference/targets/export-targets-to-csv"},{"title":"Get a target by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/targets/{id}","href":"/api-reference/targets/get-a-target-by-id"},{"title":"Update a target","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/targets/{id}","href":"/api-reference/targets/update-a-target"},{"title":"Delete a target permanently","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/targets/{id}/workspace/{workspaceId}","href":"/api-reference/targets/delete-a-target-permanently"},{"title":"Rescan a target","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/targets/{id}/re-scan","href":"/api-reference/targets/rescan-a-target"}]},{"group":"Workspaces","pages":[{"title":"Get Workspaces","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/workspaces","href":"/api-reference/workspaces/get-workspaces"},{"title":"Create Workspace","description":"Establishes a new isolated security workspace for organizing and managing assets, targets, and vulnerabilities within a dedicated environment.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/workspaces","href":"/api-reference/workspaces/create-workspace"},{"title":"Get workspace API key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/workspaces/api-key","href":"/api-reference/workspaces/get-workspace-api-key"},{"title":"Get workspace configs","description":"Retrieves the configuration settings for a specified workspace, including asset discovery and auto-enablement settings.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/workspaces/configs","href":"/api-reference/workspaces/get-workspace-configs"},{"title":"Update workspace configs","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/workspaces/configs","href":"/api-reference/workspaces/update-workspace-configs"},{"title":"Get Workspace By ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/workspaces/{id}","href":"/api-reference/workspaces/get-workspace-by-id"},{"title":"Delete Workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/workspaces/{id}","href":"/api-reference/workspaces/delete-workspace"},{"title":"Update Workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/workspaces/{id}","href":"/api-reference/workspaces/update-workspace"},{"title":"Rotate API key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/workspaces/{id}/api-key/rotate","href":"/api-reference/workspaces/rotate-api-key"},{"title":"Archive/Unarchive Workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/workspaces/{id}/archived","href":"/api-reference/workspaces/archiveunarchive-workspace"}]},{"group":"Workflows","pages":[{"title":"Get all workflow templates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/workflows/templates","href":"/api-reference/workflows/get-all-workflow-templates"},{"title":"Get many workflows","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/workflows","href":"/api-reference/workflows/get-many-workflows"},{"title":"Create workflow","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/workflows","href":"/api-reference/workflows/create-workflow"},{"title":"Get workflow by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/workflows/{id}","href":"/api-reference/workflows/get-workflow-by-id"},{"title":"Delete workflow","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/workflows/{id}","href":"/api-reference/workflows/delete-workflow"},{"title":"Update workflow","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/workflows/{id}","href":"/api-reference/workflows/update-workflow"}]},{"group":"Root","pages":[{"title":"Get apihealth","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/health","href":"/api-reference/root/get-apihealth"},{"title":"Creates the first admin user in the system.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/init-admin","href":"/api-reference/root/creates-the-first-admin-user-in-the-system"},{"title":"Get system metadata.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/metadata","href":"/api-reference/root/get-system-metadata"},{"title":"Get the latest version.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/version/latest","href":"/api-reference/root/get-the-latest-version"}]},{"group":"System Configs","pages":[{"title":"Get system configuration","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/system-configs","href":"/api-reference/system-configs/get-system-configuration"},{"title":"Update system configuration","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/system-configs","href":"/api-reference/system-configs/update-system-configuration"},{"title":"Remove system logo","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/system-configs/logo","href":"/api-reference/system-configs/remove-system-logo"}]},{"group":"JobsRegistry","pages":[{"title":"Get Jobs","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/jobs-registry","href":"/api-reference/jobsregistry/get-jobs"},{"title":"Get Jobs Timeline","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/jobs-registry/timeline","href":"/api-reference/jobsregistry/get-jobs-timeline"},{"title":"Retrieves the next job associated with the given worker that has not yet been started.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/jobs-registry/{workerId}/next","href":"/api-reference/jobsregistry/retrieves-the-next-job-associated-with-the-given-worker-that-has-not-yet-been-started"},{"title":"Updates the result of a job with the given worker ID.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/jobs-registry/{workerId}/result","href":"/api-reference/jobsregistry/updates-the-result-of-a-job-with-the-given-worker-id"},{"title":"Get Many Job Histories","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/jobs-registry/histories","href":"/api-reference/jobsregistry/get-many-job-histories"},{"title":"Get Job History Detail","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/jobs-registry/histories/{id}","href":"/api-reference/jobsregistry/get-job-history-detail"},{"title":"Re-run a job","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/jobs-registry/{id}/re-run","href":"/api-reference/jobsregistry/re-run-a-job"},{"title":"Cancel a job","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/jobs-registry/{id}/cancel","href":"/api-reference/jobsregistry/cancel-a-job"},{"title":"Delete a job","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/jobs-registry/{id}","href":"/api-reference/jobsregistry/delete-a-job"}]},{"group":"Assets","pages":[{"title":"Get assets in target","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/assets","href":"/api-reference/assets/get-assets-in-target"},{"title":"Get IP asset","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/assets/ip","href":"/api-reference/assets/get-ip-asset"},{"title":"Get host asset","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/assets/host","href":"/api-reference/assets/get-host-asset"},{"title":"Get ports and number of assets","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/assets/port","href":"/api-reference/assets/get-ports-and-number-of-assets"},{"title":"Get technologies along with number of assets","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/assets/tech","href":"/api-reference/assets/get-technologies-along-with-number-of-assets"},{"title":"Get technologies along with number of assets","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/assets/status-code","href":"/api-reference/assets/get-technologies-along-with-number-of-assets-1"},{"title":"Get TLS certificates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/assets/tls","href":"/api-reference/assets/get-tls-certificates"},{"title":"Generate AI tags for a service","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/assets/service/tag/generate","href":"/api-reference/assets/generate-ai-tags-for-a-service"},{"title":"Get asset by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/assets/{id}","href":"/api-reference/assets/get-asset-by-id"},{"title":"Update asset by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/assets/{id}","href":"/api-reference/assets/update-asset-by-id"},{"title":"Toggle asset enabled/disabled","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/assets/toggle","href":"/api-reference/assets/toggle-asset-enableddisabled"},{"title":"Export services to CSV","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/assets/services/export","href":"/api-reference/assets/export-services-to-csv"}]},{"group":"Workers","pages":[{"title":"Worker alive","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/workers/alive","href":"/api-reference/workers/worker-alive"},{"title":"Worker join","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/workers/join","href":"/api-reference/workers/worker-join"},{"title":"Get all workers with pagination and sorting.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/workers","href":"/api-reference/workers/get-all-workers-with-pagination-and-sorting"}]},{"group":"Tools","pages":[{"title":"Get tools","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/tools","href":"/api-reference/tools/get-tools"},{"title":"Create a new tool","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/tools","href":"/api-reference/tools/create-a-new-tool"},{"title":"Add tool to workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/tools/add-to-workspace","href":"/api-reference/tools/add-tool-to-workspace"},{"title":"Install tool","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/tools/install","href":"/api-reference/tools/install-tool"},{"title":"Uninstall tool","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/tools/uninstall","href":"/api-reference/tools/uninstall-tool"},{"title":"Get built-in tools","deprecated":true,"version":null,"openapi":"/api-reference/openapi.json get /api/tools/built-in-tools","href":"/api-reference/tools/get-built-in-tools"},{"title":"Get installed tools for a workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/tools/installed","href":"/api-reference/tools/get-installed-tools-for-a-workspace"},{"title":"Get tool by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/tools/{id}","href":"/api-reference/tools/get-tool-by-id"},{"title":"Get tool API key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/tools/{id}/api-key","href":"/api-reference/tools/get-tool-api-key"},{"title":"Rotate tool API key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/tools/{id}/api-key/rotate","href":"/api-reference/tools/rotate-tool-api-key"}]},{"group":"Search","pages":[{"title":"Search assets and targets","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/search","href":"/api-reference/search/search-assets-and-targets"},{"title":"Get search history","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/search/histories","href":"/api-reference/search/get-search-history"},{"title":"Delete all search history","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/search/histories","href":"/api-reference/search/delete-all-search-history"},{"title":"Delete search history by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/search/histories/{id}","href":"/api-reference/search/delete-search-history-by-id"}]},{"group":"Statistic","pages":[{"title":"Get workspace statistics","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/statistic","href":"/api-reference/statistic/get-workspace-statistics"},{"title":"Get timeline statistics for a workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/statistic/timeline","href":"/api-reference/statistic/get-timeline-statistics-for-a-workspace"},{"title":"Get issues timeline statistics for a workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/statistic/issues-timeline","href":"/api-reference/statistic/get-issues-timeline-statistics-for-a-workspace"},{"title":"Get top 10 tags with the most assets in a workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/statistic/top-tags-assets","href":"/api-reference/statistic/get-top-10-tags-with-the-most-assets-in-a-workspace"},{"title":"Get asset locations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/statistic/asset-locations","href":"/api-reference/statistic/get-asset-locations"},{"title":"Get TLS certificate statistics for a workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/statistic/tls","href":"/api-reference/statistic/get-tls-certificate-statistics-for-a-workspace"},{"title":"Get top 10 assets with the most vulnerabilities in a workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/statistic/top-assets-vulnerabilities","href":"/api-reference/statistic/get-top-10-assets-with-the-most-vulnerabilities-in-a-workspace"}]},{"group":"Vulnerabilities","pages":[{"title":"Scan target","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/vulnerabilities/scan","href":"/api-reference/vulnerabilities/scan-target"},{"title":"Get vulnerabilities","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/vulnerabilities","href":"/api-reference/vulnerabilities/get-vulnerabilities"},{"title":"Get vulnerabilities statistics","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/vulnerabilities/statistics","href":"/api-reference/vulnerabilities/get-vulnerabilities-statistics"},{"title":"Get vulnerability by id","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/vulnerabilities/{id}","href":"/api-reference/vulnerabilities/get-vulnerability-by-id"},{"title":"Analyze a vulnerability","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/vulnerabilities/{id}/analyze","href":"/api-reference/vulnerabilities/analyze-a-vulnerability"},{"title":"Delete vulnerability analysis result","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/vulnerabilities/{id}/analyze","href":"/api-reference/vulnerabilities/delete-vulnerability-analysis-result"},{"title":"Bulk dismiss vulnerabilities","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/vulnerabilities/dismiss","href":"/api-reference/vulnerabilities/bulk-dismiss-vulnerabilities"},{"title":"Bulk reopen vulnerabilities","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/vulnerabilities/reopen","href":"/api-reference/vulnerabilities/bulk-reopen-vulnerabilities"}]},{"group":"Agents","pages":[{"title":"Get agent modes","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/agents/modes","href":"/api-reference/agents/get-agent-modes"},{"title":"Create LLM config","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/agents/llm-configs","href":"/api-reference/agents/create-llm-config"},{"title":"Get supported providers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/agents/providers","href":"/api-reference/agents/get-supported-providers"},{"title":"Get connected providers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/agents/providers/connected","href":"/api-reference/agents/get-connected-providers"},{"title":"List models for a provider config","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/agents/llm-configs/{id}/models","href":"/api-reference/agents/list-models-for-a-provider-config"},{"title":"Delete LLM config","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/agents/llm-configs/{id}","href":"/api-reference/agents/delete-llm-config"},{"title":"Update LLM config","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/agents/llm-configs/{id}","href":"/api-reference/agents/update-llm-config"},{"title":"Set preferred LLM config","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/agents/llm-configs/{id}/set-preferred","href":"/api-reference/agents/set-preferred-llm-config"},{"title":"Get conversation detail","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/agents/conversations/{id}","href":"/api-reference/agents/get-conversation-detail"},{"title":"Delete conversation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/agents/conversations/{id}","href":"/api-reference/agents/delete-conversation"},{"title":"Update conversation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/agents/conversations/{id}","href":"/api-reference/agents/update-conversation"},{"title":"List conversations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/agents/conversations","href":"/api-reference/agents/list-conversations"},{"title":"Delete all conversations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/agents/conversations","href":"/api-reference/agents/delete-all-conversations"},{"title":"Get messages","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/agents/conversations/{id}/messages","href":"/api-reference/agents/get-messages"},{"title":"Send message (streaming)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/agents/messages/stream","href":"/api-reference/agents/send-message-streaming"},{"title":"Delete message","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/agents/conversations/{cid}/messages/{mid}","href":"/api-reference/agents/delete-message"},{"title":"Get MCP configs","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/agents/mcp-configs","href":"/api-reference/agents/get-mcp-configs"},{"title":"Upsert MCP server","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/agents/mcp-configs/{name}","href":"/api-reference/agents/upsert-mcp-server"},{"title":"Delete MCP server","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/agents/mcp-configs/{name}","href":"/api-reference/agents/delete-mcp-server"},{"title":"Toggle MCP server","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/agents/mcp-configs/{name}/toggle","href":"/api-reference/agents/toggle-mcp-server"},{"title":"Ping MCP server","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/agents/mcp-configs/{name}/ping","href":"/api-reference/agents/ping-mcp-server"},{"title":"Get workspace memory","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/agents/workspace-memory","href":"/api-reference/agents/get-workspace-memory"},{"title":"Delete workspace memory","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/agents/workspace-memory/{id}","href":"/api-reference/agents/delete-workspace-memory"},{"title":"List skills","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/agents/skills","href":"/api-reference/agents/list-skills"},{"title":"Create skill","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/agents/skills","href":"/api-reference/agents/create-skill"},{"title":"Delete skill","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/agents/skills/{id}","href":"/api-reference/agents/delete-skill"},{"title":"Update skill","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/agents/skills/{id}","href":"/api-reference/agents/update-skill"},{"title":"Toggle skill","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/agents/skills/{id}/toggle","href":"/api-reference/agents/toggle-skill"}]},{"group":"Notifications","pages":[{"title":"Get all notifications","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/notifications","href":"/api-reference/notifications/get-all-notifications"},{"title":"Create a notification","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/notifications","href":"/api-reference/notifications/create-a-notification"},{"title":"Subscribe to notifications stream","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/notifications/stream","href":"/api-reference/notifications/subscribe-to-notifications-stream"},{"title":"Get unread notifications count","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/notifications/unread-count","href":"/api-reference/notifications/get-unread-notifications-count"},{"title":"Mark all notifications as read","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/notifications/mark-read","href":"/api-reference/notifications/mark-all-notifications-as-read"},{"title":"Mark all notifications as unread","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/notifications/mark-unread","href":"/api-reference/notifications/mark-all-notifications-as-unread"},{"title":"Mark a specific notification as read","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/notifications/{id}/read","href":"/api-reference/notifications/mark-a-specific-notification-as-read"},{"title":"Delete a notification","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/notifications/{id}","href":"/api-reference/notifications/delete-a-notification"}]},{"group":"Integrations","pages":[{"title":"Get all integration schemas","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/integrations/schemas","href":"/api-reference/integrations/get-all-integration-schemas"},{"title":"Get all integrations for a workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/integrations","href":"/api-reference/integrations/get-all-integrations-for-a-workspace"},{"title":"Create a new integration","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/integrations","href":"/api-reference/integrations/create-a-new-integration"},{"title":"Get an integration by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/integrations/{id}","href":"/api-reference/integrations/get-an-integration-by-id"},{"title":"Delete an integration","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/integrations/{id}","href":"/api-reference/integrations/delete-an-integration"},{"title":"Update an integration","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/integrations/{id}","href":"/api-reference/integrations/update-an-integration"},{"title":"Test an integration","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/integrations/{id}/test","href":"/api-reference/integrations/test-an-integration"},{"title":"Create a Telegram pairing token","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/integrations/{id}/telegram/pairing","href":"/api-reference/integrations/create-a-telegram-pairing-token"},{"title":"Telegram bot webhook","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/integrations/telegram/webhook/{integrationId}","href":"/api-reference/integrations/telegram-bot-webhook"},{"title":"List Telegram connects for an integration","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/integrations/{id}/telegram/connects","href":"/api-reference/integrations/list-telegram-connects-for-an-integration"},{"title":"Disconnect a Telegram connect","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/integrations/{id}/telegram/connects/{connectId}","href":"/api-reference/integrations/disconnect-a-telegram-connect"}]},{"group":"Remote Execute","pages":[{"title":"Subscribe to remote-execute stream","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/remote-execute/stream","href":"/api-reference/remote-execute/subscribe-to-remote-execute-stream"}]},{"group":"Providers","pages":[{"title":"Get all providers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/providers","href":"/api-reference/providers/get-all-providers"},{"title":"Create a new provider","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/providers","href":"/api-reference/providers/create-a-new-provider"},{"title":"Get a provider by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/providers/{id}","href":"/api-reference/providers/get-a-provider-by-id"},{"title":"Delete a provider","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/providers/{id}","href":"/api-reference/providers/delete-a-provider"},{"title":"Update a provider","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/providers/{id}","href":"/api-reference/providers/update-a-provider"}]},{"group":"Templates","pages":[{"title":"Get all templates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/templates","href":"/api-reference/templates/get-all-templates"},{"title":"Create a new templates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/templates","href":"/api-reference/templates/create-a-new-templates"},{"title":"Template upload","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/templates/upload","href":"/api-reference/templates/template-upload"},{"title":"Rename a template file","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/templates/{templateId}/rename","href":"/api-reference/templates/rename-a-template-file"},{"title":"Get a template by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/templates/{templateId}","href":"/api-reference/templates/get-a-template-by-id"},{"title":"Delete a template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/templates/{templateId}","href":"/api-reference/templates/delete-a-template"}]},{"group":"Asset Group","pages":[{"title":"Get all asset groups","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/asset-group","href":"/api-reference/asset-group/get-all-asset-groups"},{"title":"Create asset group","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/asset-group","href":"/api-reference/asset-group/create-asset-group"},{"title":"Get asset group by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/asset-group/{id}","href":"/api-reference/asset-group/get-asset-group-by-id"},{"title":"Delete asset group","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/asset-group/{id}","href":"/api-reference/asset-group/delete-asset-group"},{"title":"Update asset group","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/asset-group/{id}","href":"/api-reference/asset-group/update-asset-group"},{"title":"Add multiple workflows to asset group","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/asset-group/{groupId}/workflows","href":"/api-reference/asset-group/add-multiple-workflows-to-asset-group"},{"title":"Remove multiple workflows from asset group","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/asset-group/{groupId}/workflows","href":"/api-reference/asset-group/remove-multiple-workflows-from-asset-group"},{"title":"Add multiple assets to asset group","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/asset-group/{groupId}/assets","href":"/api-reference/asset-group/add-multiple-assets-to-asset-group"},{"title":"Remove multiple assets from asset group","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/asset-group/{groupId}/assets","href":"/api-reference/asset-group/remove-multiple-assets-from-asset-group"},{"title":"Get assets by asset group ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/asset-group/{assetGroupId}/assets","href":"/api-reference/asset-group/get-assets-by-asset-group-id"},{"title":"Get workflows by asset group ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/asset-group/{assetGroupId}/workflows","href":"/api-reference/asset-group/get-workflows-by-asset-group-id"},{"title":"Get assets not in asset group","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/asset-group/{assetGroupId}/assets/not-in-group","href":"/api-reference/asset-group/get-assets-not-in-asset-group"},{"title":"Get workflows not in asset group (preinstalled in workspace)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/asset-group/{assetGroupId}/workflows/not-in-group","href":"/api-reference/asset-group/get-workflows-not-in-asset-group-preinstalled-in-workspace"},{"title":"Update asset group workflow relationship","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/asset-group/workflows/{id}","href":"/api-reference/asset-group/update-asset-group-workflow-relationship"},{"title":"Runs the scheduler for a specific asset group workflow.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/asset-group/workflows/{id}/run","href":"/api-reference/asset-group/runs-the-scheduler-for-a-specific-asset-group-workflow"}]},{"group":"InternalNetworks","pages":[{"title":"Get many internal networks","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/internal-networks","href":"/api-reference/internalnetworks/get-many-internal-networks"},{"title":"Create an internal network","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/internal-networks","href":"/api-reference/internalnetworks/create-an-internal-network"},{"title":"Create targets from network interfaces","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/internal-networks/targets","href":"/api-reference/internalnetworks/create-targets-from-network-interfaces"},{"title":"Get many network interfaces for an internal network","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/internal-networks/{id}/network-interfaces","href":"/api-reference/internalnetworks/get-many-network-interfaces-for-an-internal-network"},{"title":"Get an internal network by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/internal-networks/{id}","href":"/api-reference/internalnetworks/get-an-internal-network-by-id"},{"title":"Delete an internal network","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/internal-networks/{id}","href":"/api-reference/internalnetworks/delete-an-internal-network"},{"title":"Update an internal network by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/internal-networks/{id}","href":"/api-reference/internalnetworks/update-an-internal-network-by-id"}]},{"group":"Reports","pages":[{"title":"List reports","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/reports","href":"/api-reference/reports/list-reports"},{"title":"Get apireportspreviewsummary","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/reports/preview/summary","href":"/api-reference/reports/get-apireportspreviewsummary"},{"title":"Get apireportspreviewvulnerability","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/reports/preview/vulnerability","href":"/api-reference/reports/get-apireportspreviewvulnerability"},{"title":"Generate summary PDF report","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/reports/generate/summary","href":"/api-reference/reports/generate-summary-pdf-report"},{"title":"Generate vulnerability PDF report","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/reports/generate/vulnerability","href":"/api-reference/reports/generate-vulnerability-pdf-report"},{"title":"Delete report","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/reports/{id}","href":"/api-reference/reports/delete-report"}]},{"group":"Storage","pages":[{"title":"Upload app logo to system bucket","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/storage/logo","href":"/api-reference/storage/upload-app-logo-to-system-bucket"},{"title":"Upload a file to storage","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/storage/upload","href":"/api-reference/storage/upload-a-file-to-storage"},{"title":"Download a file with time-limited token","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/storage/{bucket}/{path}/download","href":"/api-reference/storage/download-a-file-with-time-limited-token"},{"title":"Get a file from storage (public)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/storage/{bucket}/{path}","href":"/api-reference/storage/get-a-file-from-storage-public"}]},{"group":"MCP","pages":[{"title":"Get apimcp","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/mcp","href":"/api-reference/mcp/get-apimcp"},{"title":"Post apimcpmessage","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/mcp/message","href":"/api-reference/mcp/post-apimcpmessage"}]}]}]},"title":"Get workspace API key - OASM","buildId":"dpl_9DauxEjb9gzCtcuhPQFbquJvx7FJ","deploymentId":"dpl_9DauxEjb9gzCtcuhPQFbquJvx7FJ","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-D7-Gje8a.js","utils-KOiC3qHY.js","cloneDeep-DEhA10yQ.js","_Uint8Array-BIdfUDMD.js","isArray-9Clv05ut.js","utils-CmcaQEbY.js","toString-CsGphfAF.js","addUniqueKeysToSchema-4JTjWsHh.js","snippetPresets-ddvRvPzi.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","Page-CF9KAtIE.js","ApiExamples-NlqoL_h5.js","isEqual-D9eQogBc.js","usePlaygroundInputsStore-D_c36cCU.js","shallow-D2OGx4iM.js","getApiPlaygroundDisplay-CMrT2UNh.js","ChevronDownIcon-C27UQjyC.js","CodeSnippet-D019nHfQ.js","CodeSnippets-BC8hDW4S.js","getPastedJson-DoxVtgHa.js","icon-Dtg1NSY8.js","MethodPill-BQ0_b2IL.js","DynamicMarkdown-BY_qDhTn.js","SectionHeading-wQwiJd89.js","ArrowRotateAnticlockwiseIcon-DDnTkD_e.js","CircleWarningIcon-DI7T-tmv.js","PlusIcon-CwhPVjTe.js","TrashIcon-DDC8cDJT.js","axios-vUo_bRtp.js","Markdown-BA8elm3x.js","clsx-D-31Aetf.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-Bd0qg17S.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-DM8kDBn3.js"]}