Last updated on Nov 05, 2024You can use APIs to manage users, and retrieve data about your build history. To enhance security for our API calls, you need to use a custom API key in every API call.
API Keys
User Management API
External User Management API
Build History API
Command Line Interface (CLI)
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"IncrediBuild Documentation","colors":{"primary":"#16A34A","light":"#07C983","dark":"#15803D"},"logo":{"light":"https://mintcdn.com/incredibuild-docs-migrated/a90IOkXrBeudmNJU/images/logo-light.svg?fit=max\u0026auto=format\u0026n=a90IOkXrBeudmNJU\u0026q=85\u0026s=74d7751f22e305e5f7e543929f7c64e3","dark":"https://mintcdn.com/incredibuild-docs-migrated/a90IOkXrBeudmNJU/images/logo-dark.svg?fit=max\u0026auto=format\u0026n=a90IOkXrBeudmNJU\u0026q=85\u0026s=2545789b1ee6a74f9f7c9186ef6a3b3e"},"favicon":"https://mintcdn.com/incredibuild-docs-migrated/J_iESDJtkumUEvdP/images/favicon.svg?fit=max\u0026auto=format\u0026n=J_iESDJtkumUEvdP\u0026q=85\u0026s=d4a56a75bbe0364d0ef863d3183e06ca","navbar":{"links":[{"href":"https://www.incredibuild.com/support","label":"Support"}]},"footer":{"socials":{"x":"https://x.com/Incredibuild","github":"https://github.com/Incredibuild-RND","linkedin":"https://linkedin.com/company/incredibuild"}},"integrations":{"gtm":{"tagId":"GTM-P4S7537"},"posthog":{"apiKey":"phc_78QqWhPGnAx46NqlRahsOjygVlyPJ4g3EyLzbplwzZm","sessionRecording":false}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","cursor"],"display":"header"},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"incredibuild-docs-migrated","hasAudioNarration":false,"actualSubdomain":"incredibuild-docs-migrated","customDomains":["docs.incredibuild.com"],"gitSource":{"type":"github","owner":"incredibuild-rnd","repo":"docs-mintlify-live","deployBranch":"master","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"collectionId":"ce36e4d0-eb18-4c07-8a00-83eeef58da95","liveDeploymentHistoryId":"6ada2e542cd1c8b6f015a391","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ada2e542cd1c8b6f015a391"},"entitlements":{},"buildId":"6ada2e542cd1c8b6f015a391","clientVersion":"0.0.3939","searchFilterCounts":[{"language":"default","tag":"Windows","count":4524},{"language":"default","tag":"Linux","count":1559},{"language":"default","tag":"Integrations","count":1534},{"language":"default","tag":"Features and Settings","count":1267},{"language":"default","tag":"Installation","count":875},{"language":"default","tag":"Other","count":752},{"language":"default","tag":"Devtools Solution","count":705},{"language":"default","tag":"Running Builds","count":645},{"language":"default","tag":"Integration Interfaces","count":498},{"language":"default","tag":"Introduction","count":354}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":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":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"linux/4.29.2/api-section","slug":"/linux/4.29.2/api-section","pageMetadata":{"title":"API Reference","description":null,"href":"/linux/4.29.2/api-section"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,p:`p`,..._provideComponents(),...props.components};return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Last updated on Nov 05, 2024`}),`\n`,_jsxs(_components.p,{children:[`You can use APIs to `,_jsx(_components.a,{href:`/linux/4.29.2/api-users`,children:`manage users`}),`, and retrieve data about your `,_jsx(_components.a,{href:`/linux/4.29.2/api-build-data`,children:`build history`}),`. To enhance security for our API calls, you need to use a custom `,_jsx(_components.a,{href:`/linux/4.29.2/api-keys`,children:`API key`}),` in every API call.`]})]})}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":"API Reference","description":null,"href":"/linux/4.29.2/api-section"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"subdomain":"incredibuild-docs-migrated","siteName":"IncrediBuild Documentation","title":"API Reference - IncrediBuild Documentation","navMaps":{"firstHrefInVersion":{"10.38.1":{"href":"/","matchLevel":4},"10.38.0":{"href":"/windows/10.38.0/overview","matchLevel":4},"10.37.1":{"href":"/windows/10.37.1/overview","matchLevel":4},"10.37.0":{"href":"/windows/10.37.0/overview","matchLevel":4},"10.36.3":{"href":"/windows/10.36.3/overview","matchLevel":4},"10.36.2":{"href":"/windows/10.36.2/overview","matchLevel":4},"10.36.1":{"href":"/windows/10.36.1/overview","matchLevel":4},"10.36.0":{"href":"/windows/10.36.0/overview","matchLevel":4},"10.35.3":{"href":"/windows/10.35.3/index","matchLevel":4},"10.35.2":{"href":"/windows/10.35.2/index","matchLevel":4},"10.35.1":{"href":"/windows/10.35.1/index","matchLevel":4},"10.35.0":{"href":"/windows/10.35.0/overview","matchLevel":4},"10.34.3":{"href":"/windows/10.34.3/release-notes","matchLevel":4},"10.34.2":{"href":"/windows/10.34.2/release-notes","matchLevel":4},"10.34.1":{"href":"/windows/10.34.1/release-notes","matchLevel":4},"10.34.0":{"href":"/windows/10.34.0/release-notes","matchLevel":4},"10.33.0":{"href":"/windows/10.33.0/release-notes","matchLevel":4},"10.32.2":{"href":"/windows/10.32.2/release-notes","matchLevel":4},"10.32.1":{"href":"/windows/10.32.1/release-notes","matchLevel":4},"10.32.0":{"href":"/windows/10.32.0/release-notes","matchLevel":4},"10.31.2":{"href":"/windows/10.31.2/release-notes","matchLevel":4},"10.31.1":{"href":"/windows/10.31.1/release-notes","matchLevel":4},"10.31.0":{"href":"/windows/10.31.0/release-notes","matchLevel":4},"10.30.0":{"href":"/windows/10.30.0/release-notes","matchLevel":4},"10.29.1":{"href":"/windows/10.29.1/release-notes","matchLevel":4},"10.29":{"href":"/windows/10.29/release-notes","matchLevel":4},"10.28":{"href":"/windows/10.28/release-notes","matchLevel":4},"10.27.1":{"href":"/windows/10.27.1/release-notes","matchLevel":4},"10.27":{"href":"/windows/10.27/release-notes","matchLevel":4},"10.26":{"href":"/windows/10.26/release-notes","matchLevel":4},"4.30.2":{"href":"/linux/api-section","matchLevel":2},"4.30.1":{"href":"/linux/4.30.1/api-section","matchLevel":1},"4.30.0":{"href":"/linux/4.30.0/api-section","matchLevel":1},"4.29.3":{"href":"/linux/4.29.3/api-section","matchLevel":1},"4.29.2":{"href":"/linux/4.29.2/api-section","matchLevel":0},"4.29.0":{"href":"/linux/4.29.0/api-section","matchLevel":1},"4.27.2":{"href":"/linux/4.27.2/api-section","matchLevel":1},"4.27.1":{"href":"/linux/4.27.1/api-section","matchLevel":1},"4.27.0":{"href":"/linux/4.27.0/api-section","matchLevel":1},"4.26.1":{"href":"/linux/4.26.1/api-section","matchLevel":1},"4.26.0":{"href":"/linux/4.26.0/api-section","matchLevel":1},"4.25.0":{"href":"/linux/4.25.0/api-section","matchLevel":1},"4.24.0":{"href":"/linux/4.24.0/api-section","matchLevel":1},"4.23.0":{"href":"/linux/4.23.0/api-section","matchLevel":1},"4.22.0":{"href":"/linux/4.22.0/api-section","matchLevel":1},"4.21.0":{"href":"/linux/4.21.0/api-section","matchLevel":1},"4.20.0":{"href":"/linux/4.20.0/api-section","matchLevel":1},"4.19.1":{"href":"/linux/4.19.1/api-section","matchLevel":1},"4.19.0":{"href":"/linux/4.19.0/api-section","matchLevel":1},"4.18.1":{"href":"/linux/4.18.1/api-section","matchLevel":1},"4.18.0":{"href":"/linux/4.18.0/api-section","matchLevel":1},"4.12":{"href":"/mac/overview","matchLevel":4},"4.11.0":{"href":"/mac/4.11.0/release-notes","matchLevel":4},"4.10.0":{"href":"/mac/4.10.0/release-notes","matchLevel":4},"4.9.0":{"href":"/mac/4.9.0/release-notes","matchLevel":4}},"firstHrefInLanguage":{}},"lastModified":"2026-09-07T15:59:34.377Z","originalFileLocation":"linux/4.29.2/api-section.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=\"application-name\" content=\"IncrediBuild 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/incredibuild-docs-migrated/0baZAtTsfgTDpi0G/_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/incredibuild-docs-migrated/0baZAtTsfgTDpi0G/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/incredibuild-docs-migrated/0baZAtTsfgTDpi0G/_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/incredibuild-docs-migrated/0baZAtTsfgTDpi0G/_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/incredibuild-docs-migrated/0baZAtTsfgTDpi0G/_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/incredibuild-docs-migrated/0baZAtTsfgTDpi0G/_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/incredibuild-docs-migrated/0baZAtTsfgTDpi0G/_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/incredibuild-docs-migrated/0baZAtTsfgTDpi0G/_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/incredibuild-docs-migrated/0baZAtTsfgTDpi0G/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"API Reference - IncrediBuild Documentation\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"IncrediBuild Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.incredibuild.com/linux/4.29.2/api-section\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://incredibuild-docs-migrated.mintlify.app/_mintlify/api/og/v2?division=Documentation\u0026amp;title=API+Reference\u0026amp;theme=4aa88dad13668d98b637dfd2\u0026amp;signature=b782fec07d2caea9940a40f8758fb305d22275b9db89bd29c12c68e9b5a413d0\">\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 Reference - IncrediBuild Documentation\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://incredibuild-docs-migrated.mintlify.app/_mintlify/api/og/v2?division=Documentation\u0026amp;title=API+Reference\u0026amp;theme=4aa88dad13668d98b637dfd2\u0026amp;signature=b782fec07d2caea9940a40f8758fb305d22275b9db89bd29c12c68e9b5a413d0\">\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/incredibuild-docs-migrated/0baZAtTsfgTDpi0G/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"IncrediBuild Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#16A34A\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.incredibuild.com/linux/4.29.2/api-section\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/linux/4.29.2/api-section.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.incredibuild.com/#organization\",\"name\":\"IncrediBuild Documentation\",\"url\":\"https://docs.incredibuild.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/incredibuild-docs-migrated/a90IOkXrBeudmNJU/images/logo-light.svg?fit=max\u0026auto=format\u0026n=a90IOkXrBeudmNJU\u0026q=85\u0026s=74d7751f22e305e5f7e543929f7c64e3\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.incredibuild.com#website\",\"name\":\"IncrediBuild Documentation\",\"url\":\"https://docs.incredibuild.com\",\"publisher\":{\"@id\":\"https://docs.incredibuild.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.incredibuild.com/linux/4.29.2/api-section#webpage\",\"url\":\"https://docs.incredibuild.com/linux/4.29.2/api-section\",\"name\":\"API Reference\",\"dateModified\":\"2026-09-07T15:59:34.377Z\",\"isPartOf\":{\"@id\":\"https://docs.incredibuild.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.incredibuild.com/linux/4.29.2/api-section#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.incredibuild.com/linux/4.29.2/api-section#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"IncrediBuild Documentation\",\"item\":\"https://docs.incredibuild.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"API Reference\",\"item\":\"https://docs.incredibuild.com/linux/4.29.2/api-section\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.incredibuild.com/linux/4.29.2/api-section#article\",\"headline\":\"API Reference\",\"name\":\"API Reference\",\"url\":\"https://docs.incredibuild.com/linux/4.29.2/api-section\",\"mainEntityOfPage\":{\"@id\":\"https://docs.incredibuild.com/linux/4.29.2/api-section#webpage\"},\"dateModified\":\"2026-09-07T15:59:34.377Z\",\"publisher\":{\"@id\":\"https://docs.incredibuild.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.incredibuild.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"IncrediBuild Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"IncrediBuild Documentation","nav":{"global":null,"products":[{"product":"Windows","icon":"windows","directory":"card","pages":[{"title":"Windows","href":""}]},{"product":"Linux","icon":"linux","directory":"card","versions":[{"version":"4.30.2","default":true,"tag":"Latest","pages":[{"title":"4.30.2","href":"/linux/api-section"}]},{"version":"4.30.1","pages":[{"title":"4.30.1","href":"/linux/4.30.1/api-section"}]},{"version":"4.30.0","pages":[{"title":"4.30.0","href":"/linux/4.30.0/api-section"}]},{"version":"4.29.3","pages":[{"title":"4.29.3","href":"/linux/4.29.3/api-section"}]},{"version":"4.29.2","groups":[{"group":"Overview","pages":[{"title":"Incredibuild for Linux","href":"/linux/4.29.2/overview"},{"title":"Release Notes","href":"/linux/4.29.2/release-notes"}]},{"group":"Introduction","root":{"title":"Getting Started","href":"/linux/4.29.2/getting-started"},"pages":[{"title":"Introduction to Incredibuild","href":"/linux/4.29.2/introduction"},{"title":"Incredibuild Architecture and Terminology","href":"/linux/4.29.2/incredibuild-technology"},{"title":"High Availability and Recovery Functionality","href":"/linux/4.29.2/high-availability"},{"title":"Incredibuild Linux - Benefits and Usage","href":"/linux/4.29.2/incredibuild-benefits-usage"}]},{"group":"Installation","root":{"title":"Installation and Upgrade","href":"/linux/4.29.2/installing"},"pages":[{"title":"Supported Platforms and Tools","href":"/linux/4.29.2/supported-platforms-tools"},{"group":"System Requirements","pages":[{"title":"System Requirements","href":"/linux/4.29.2/system-requirements"},{"title":"Disabling SELinux","href":"/linux/4.29.2/disable-selinux"}]},{"title":"Installation Overview","href":"/linux/4.29.2/installation-overview"},{"title":"Installing Components","href":"/linux/4.29.2/installing-components"},{"title":"Modifying Ports","href":"/linux/4.29.2/ports"},{"title":"SSL and HTTPS","href":"/linux/4.29.2/ssl-https"},{"title":"Upgrading and Downgrading","href":"/linux/4.29.2/upgrade"},{"title":"Uninstalling Incredibuild Linux","href":"/linux/4.29.2/uninstalling"},{"title":"Checking the Status and Version No. of Incredibuild","href":"/linux/4.29.2/check-status-version-installed-components"},{"title":"Moving the Coordinator to a New Machine","href":"/linux/4.29.2/coordinator-move"},{"title":"Using Helpers with Many CPU Cores","href":"/linux/4.29.2/helpers-with-many-cpu-cores"}]},{"group":"Integrations","root":{"title":"Executing Builds","href":"/linux/4.29.2/execute-builds"},"pages":[{"title":"Executing Your Builds Using Incredibuild Linux","href":"/linux/4.29.2/execute-builds-linux"},{"title":"Using the Sample Builds","href":"/linux/4.29.2/using-sample-builds"},{"title":"Build Cache","href":"/linux/4.29.2/build-avoidance"},{"group":"Customize Builds Add Custom Tools Ibprofile","pages":[{"title":"Customizing Build Executions and Adding Custom Tools Using the ib_profile.xml File","href":"/linux/4.29.2/customize-builds-add-custom-tools-ibprofile"},{"title":"What is the ib_profile.xml File?","href":"/linux/4.29.2/ibprofile-file"},{"title":"Understanding the Hierarchy of the ib_profile.xml Files","href":"/linux/4.29.2/ib-profile-hierarchy-understanding"},{"title":"Exploring the Distribution Types of Tools and Processes","href":"/linux/4.29.2/distribution-types-tools-processes"},{"title":"Adding Custom Tools and Processes to an ib_profile.xml File","href":"/linux/4.29.2/add-custom-tools-ibprofile"},{"title":"Customize Build Executions Using Regular Expressions and Arguments in the ib_profile.xml File","href":"/linux/4.29.2/customize-builds-using-regex-ibprofile"}]},{"title":"Accelerating Android OS Project Builds","href":"/linux/4.29.2/aospb"},{"title":"Running Yocto Builds","href":"/linux/4.29.2/yocto"},{"title":"Docker and Other Containers","href":"/linux/4.29.2/docker"},{"title":"Kubernetes","href":"/linux/4.29.2/kubernetes"},{"title":"Running Incredibuild in Windows Subsystem for Linux (WSL)","href":"/linux/4.29.2/wsl"},{"title":"Intel Compiler Executions","href":"/linux/4.29.2/intel-compiler-executions"},{"title":"Collecting Build Logs","href":"/linux/4.29.2/log-location"}]},{"group":"Features and Settings","root":{"title":"Monitoring Builds","href":"/linux/4.29.2/monitor-build"},"pages":[{"title":"Accessing the Initiator's Management Console","href":"/linux/4.29.2/management-console"},{"title":"Build Monitor Overview","href":"/linux/4.29.2/build-progress-overview"},{"title":"Using the Build Monitor Toolbar","href":"/linux/4.29.2/build-progress-toolbar"},{"title":"Build Monitor Graphical View","href":"/linux/4.29.2/build-progress-graphical-view"},{"title":"Build Monitor Textual View","href":"/linux/4.29.2/build-progress-textual"},{"title":"Build Monitor Summary View","href":"/linux/4.29.2/build-progress-summary"},{"title":"Build History","href":"/linux/4.29.2/build-history"},{"title":"Running with --no-monitor","href":"/linux/4.29.2/running-no-monitor"},{"title":"Dashboards","href":"/linux/4.29.2/dashboard-builds"}]},{"group":"Running Builds","root":{"title":"Management and Settings","href":"/linux/4.29.2/management-settings"},"pages":[{"title":"Accessing the Coordinator Manager","href":"/linux/4.29.2/coord-access"},{"title":"Viewing Agents","href":"/linux/4.29.2/coordinator-agents-list"},{"title":"Agent Actions","href":"/linux/4.29.2/coordinator-agent-list-actions"},{"title":"Build List","href":"/linux/4.29.2/build-list"},{"group":"Manage Licenses Agents","root":{"title":"Licenses","href":"/linux/4.29.2/manage-licenses-agents"},"pages":[{"title":"License Overview","href":"/linux/4.29.2/license-overview"},{"title":"Activating Licenses","href":"/linux/4.29.2/activate-license"},{"title":"Standard Licenses","href":"/linux/4.29.2/license-standard"},{"title":"SUVM Licenses","href":"/linux/4.29.2/suvm"}]},{"title":"User Management","href":"/linux/4.29.2/user-management"},{"title":"User Management Integration with External System","href":"/linux/4.29.2/user-management-integration"},{"title":"Agent Console User Management","href":"/linux/4.29.2/agent-console-user-management"},{"title":"Coordinator Settings","href":"/linux/4.29.2/coordinator-settings"},{"title":"Agent Settings","href":"/linux/4.29.2/agent-settings"},{"title":"Build Groups","href":"/linux/4.29.2/build-groups"},{"title":"Backing Up and Restoring Coordinator Data","href":"/linux/4.29.2/backup"},{"title":"Secondary Coordinator","href":"/linux/4.29.2/secondary-coordinator"}]},{"group":"Overview","pages":[{"title":"Incredibuild Cloud","description":null,"href":"/linux/4.29.2/cloud-overview"}]},{"group":"Monitoring","root":{"title":"API Reference","href":"/linux/4.29.2/api-section"},"pages":[{"title":"API Keys","description":null,"href":"/linux/4.29.2/api-keys"},{"title":"User Management API","description":null,"href":"/linux/4.29.2/api-users"},{"title":"External User Management API","description":null,"href":"/linux/4.29.2/api-external-user"},{"title":"Build History API","description":null,"href":"/linux/4.29.2/api-build-data"},{"title":"Command Line Interface (CLI)","description":null,"href":"/linux/4.29.2/cli"}]},{"group":"API","root":{"title":"Troubleshooting","href":"/linux/4.29.2/troubleshooting"},"pages":[{"title":"Exporting Log Files","href":"/linux/4.29.2/export-log-files"},{"title":"Site Survey Tool","href":"/linux/4.29.2/site-survey-tool"},{"title":"Incredibuild Help","href":"/linux/4.29.2/help-menu"}]},{"group":"Overview","root":{"title":"List of Open Sources","href":"/linux/4.29.2/open-sources"},"pages":[{"title":"Product Usage Data Collection","href":"/linux/4.29.2/telemetry"}]},{"group":"Other","root":{"title":"Accelerating Android OS Builds (AOSP)","href":"/linux/4.29.2/aosp"},"pages":[{"title":"Settings","href":"/linux/4.29.2/config-settings-coordinator-agents"},{"title":"Links to All Available Versions of Linux Documentation","href":"/linux/4.29.2/linux-versions"},{"title":"Incredibuild for Qt Creator","href":"/linux/4.29.2/qt-creator"},{"title":"Subscribing and Unsubscribing Agents","href":"/linux/4.29.2/subscribing-agents"},{"title":"Windows vs. Linux: Features Comparison","href":"/linux/4.29.2/win-lin-features"},{"title":"User Management","href":"/linux/4.29.2/z-auth-user-agent-console"},{"title":"Coordinator Monitor","href":"/linux/4.29.2/z-coordinator-monitor"},{"title":"Standard Licenses","href":"/linux/4.29.2/z-manage-agent-subscription"},{"title":"Reports","href":"/linux/4.29.2/z-reports"},{"title":"Incredibuild for Linux","href":"/linux/4.29.2/index"}]}]},{"version":"4.29.0","pages":[{"title":"4.29.0","href":"/linux/4.29.0/api-section"}]},{"version":"4.27.2","pages":[{"title":"4.27.2","href":"/linux/4.27.2/api-section"}]},{"version":"4.27.1","pages":[{"title":"4.27.1","href":"/linux/4.27.1/api-section"}]},{"version":"4.27.0","pages":[{"title":"4.27.0","href":"/linux/4.27.0/api-section"}]},{"version":"4.26.1","pages":[{"title":"4.26.1","href":"/linux/4.26.1/api-section"}]},{"version":"4.26.0","pages":[{"title":"4.26.0","href":"/linux/4.26.0/api-section"}]},{"version":"4.25.0","pages":[{"title":"4.25.0","href":"/linux/4.25.0/api-section"}]},{"version":"4.24.0","pages":[{"title":"4.24.0","href":"/linux/4.24.0/api-section"}]},{"version":"4.23.0","pages":[{"title":"4.23.0","href":"/linux/4.23.0/api-section"}]},{"version":"4.22.0","pages":[{"title":"4.22.0","href":"/linux/4.22.0/api-section"}]},{"version":"4.21.0","pages":[{"title":"4.21.0","href":"/linux/4.21.0/api-section"}]},{"version":"4.20.0","pages":[{"title":"4.20.0","href":"/linux/4.20.0/api-section"}]},{"version":"4.19.1","pages":[{"title":"4.19.1","href":"/linux/4.19.1/api-section"}]},{"version":"4.19.0","pages":[{"title":"4.19.0","href":"/linux/4.19.0/api-section"}]},{"version":"4.18.1","pages":[{"title":"4.18.1","href":"/linux/4.18.1/api-section"}]},{"version":"4.18.0","pages":[{"title":"4.18.0","href":"/linux/4.18.0/api-section"}]}]},{"product":"Mac","icon":"apple","directory":"card","pages":[{"title":"Mac","href":"/mac/overview"}]},{"product":"Cloud","icon":"cloud","directory":"card","pages":[{"title":"Cloud","href":"/cloud/overview"}]},{"product":"Incredibuild Console","icon":"gauge","directory":"card","pages":[{"title":"Incredibuild Console","href":"/console/overview"}]}]},"title":"API Reference - IncrediBuild Documentation","buildId":"dpl_5UDDZ9hnigTkoV7QtvQ39eUp84nu","deploymentId":"dpl_5UDDZ9hnigTkoV7QtvQ39eUp84nu","dynamics":[],"chunks":[]}
