Start the containers and confirm the instance is ready.
If you are installing for the first time, use the complete Docker Compose guide. It includes the configuration, secrets, startup, and first sign-in.From the directory containing your Compose file:
docker compose up -ddocker compose pscurl --fail http://localhost:5173/api/health
If a service is unhealthy, run docker compose logs --tail=100 kaneo postgres and follow Troubleshooting.After changing .env, run docker compose up -d --force-recreate kaneo so the container receives the new values.For a public instance, continue with Nginx and HTTPS.
Was this page helpful?
⌘I
{"docsConfig":{"theme":"almond","$schema":"https://mintlify.com/docs.json","name":"Kaneo","colors":{"primary":"#111111","light":"#fafafa","dark":"#1f1f1f"},"logo":{"light":"https://mintcdn.com/kaneo/5yhrF9JhaeVdZ2IR/logo/dark.svg?fit=max\u0026auto=format\u0026n=5yhrF9JhaeVdZ2IR\u0026q=85\u0026s=8ca9f5b9fe8ca4d39a0ed648a4b06484","dark":"https://mintcdn.com/kaneo/5yhrF9JhaeVdZ2IR/logo/light.svg?fit=max\u0026auto=format\u0026n=5yhrF9JhaeVdZ2IR\u0026q=85\u0026s=9dfa10c89eaaef8ce2987d252a655cc7"},"favicon":"https://mintcdn.com/kaneo/ZqEvkaN2siy4EStX/favicon.svg?fit=max\u0026auto=format\u0026n=ZqEvkaN2siy4EStX\u0026q=85\u0026s=4db00a078cb64b496ad7743590218ca4","appearance":{"default":"dark"},"navbar":{"links":[{"href":"https://github.com/usekaneo/kaneo","label":"GitHub"}],"primary":{"type":"button","label":"Open Kaneo","href":"https://cloud.kaneo.app"}},"footer":{"socials":{"website":"https://kaneo.app","github":"https://github.com/usekaneo/kaneo","x":"https://x.com/usekaneo"}},"seo":{"metatags":{"og:site_name":"Kaneo Docs","og:type":"website","og:image":"https://kaneo.app/images/hero.png","twitter:card":"summary_large_image","twitter:site":"@usekaneo","twitter:image":"https://kaneo.app/images/hero.png"},"indexing":"all"},"fonts":{"family":"Geist Variable","source":"https://kaneo.app/docs/fonts/geist.woff2","format":"woff2"},"icons":{"library":"lucide"},"styling":{"codeblocks":{"theme":{"light":"min-light","dark":"min-dark"}},"latex":true},"integrations":{"plausible":{"domain":"kaneo.app","server":"plausible.kaneo.app"}},"contextual":{"options":["copy","view","chatgpt","claude","cursor"],"display":"header"},"navigation":{"global":{"anchors":[{"anchor":"Website","icon":"globe","href":"https://kaneo.app"},{"anchor":"GitHub","icon":"github","href":"https://github.com/usekaneo/kaneo"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"kaneo","hasAudioNarration":false,"actualSubdomain":"kaneo","customDomains":["kaneo.app"],"gitSource":{"type":"github","owner":"usekaneo","repo":"kaneo","deployBranch":"main","contentDirectory":"apps/docs","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{},"buildId":"6af45ec5bc2b4cf01282b1c2","clientVersion":"0.0.4205","searchFilterCounts":[{"language":"default","tag":"Developers","count":272},{"language":"default","tag":"Endpoint reference","count":262},{"language":"default","tag":"Admin","count":44},{"language":"default","tag":"Organization Management","count":35},{"language":"default","tag":"Tasks","count":26},{"language":"default","tag":"Self-hosting","count":21},{"language":"default","tag":"Using Kaneo","count":21},{"language":"default","tag":"Projects","count":16},{"language":"default","tag":"Integrations","count":15},{"language":"default","tag":"Custom Fields","count":9}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"/docs","hasChatPermissions":false,"hasWebMcpPermissions":false,"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":"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":"control","enabled":true,"payload":{"type":"string","value":"control"},"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}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"core/installation/start-services","slug":"/core/installation/start-services","pageMetadata":{"title":"Start and check Kaneo","description":"Start the containers and confirm the instance is ready.","href":"/core/installation/start-services"},"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 the containers and confirm the instance is ready.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,pre:`pre`,span:`span`,..._provideComponents(),...props.components},{CodeBlock}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`If you are installing for the first time, use the complete `,_jsx(_components.a,{href:`/core/installation/docker-compose`,children:`Docker Compose guide`}),`. It includes the configuration, secrets, startup, and first sign-in.`]}),`\n`,_jsx(_components.p,{children:`From the directory containing your Compose file:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`3`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes min-light min-dark`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#1f1f1f`,color:`#24292eff`,\"--shiki-dark\":`#b392f0`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`3`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#6F42C1`,\"--shiki-dark\":`#B392F0`},children:`docker`}),_jsx(_components.span,{style:{color:`#2B5581`,\"--shiki-dark\":`#9DB1C5`},children:` compose`}),_jsx(_components.span,{style:{color:`#2B5581`,\"--shiki-dark\":`#9DB1C5`},children:` up`}),_jsx(_components.span,{style:{color:`#2B5581`,\"--shiki-dark\":`#9DB1C5`},children:` -d`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#6F42C1`,\"--shiki-dark\":`#B392F0`},children:`docker`}),_jsx(_components.span,{style:{color:`#2B5581`,\"--shiki-dark\":`#9DB1C5`},children:` compose`}),_jsx(_components.span,{style:{color:`#2B5581`,\"--shiki-dark\":`#9DB1C5`},children:` ps`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#6F42C1`,\"--shiki-dark\":`#B392F0`},children:`curl`}),_jsx(_components.span,{style:{color:`#2B5581`,\"--shiki-dark\":`#9DB1C5`},children:` --fail`}),_jsx(_components.span,{style:{color:`#2B5581`,\"--shiki-dark\":`#9DB1C5`},children:` http://localhost:5173/api/health`})]}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`If a service is unhealthy, run `,_jsx(_components.code,{children:`docker compose logs --tail=100 kaneo postgres`}),` and follow `,_jsx(_components.a,{href:`/core/operations/troubleshooting`,children:`Troubleshooting`}),`.`]}),`\n`,_jsxs(_components.p,{children:[`After changing `,_jsx(_components.code,{children:`.env`}),`, run `,_jsx(_components.code,{children:`docker compose up -d --force-recreate kaneo`}),` so the container receives the new values.`]}),`\n`,_jsxs(_components.p,{children:[`For a public instance, continue with `,_jsx(_components.a,{href:`/core/reverse-proxy/nginx`,children:`Nginx and HTTPS`}),`.`]})]})}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":{"codeStyling":{"theme":{"light":"min-light","dark":"min-dark"}},"config":{},"pageMetadata":{"title":"Start and check Kaneo","description":"Start the containers and confirm the instance is ready.","href":"/core/installation/start-services"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"subdomain":"kaneo","siteName":"Kaneo","title":"Start and check Kaneo - Kaneo","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-26T19:56:55.221Z","originalFileLocation":"core/installation/start-services.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=\"dark\"}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 the containers and confirm the instance is ready.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Kaneo\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/kaneo/eimVFFGnKRYPxM9e/_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=\"/docs/mintlify-assets/_mintlify/favicons/kaneo/eimVFFGnKRYPxM9e/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/kaneo/eimVFFGnKRYPxM9e/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/kaneo/eimVFFGnKRYPxM9e/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/kaneo/eimVFFGnKRYPxM9e/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/kaneo/eimVFFGnKRYPxM9e/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/kaneo/eimVFFGnKRYPxM9e/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/kaneo/eimVFFGnKRYPxM9e/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/kaneo/eimVFFGnKRYPxM9e/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Start and check Kaneo - Kaneo\">\u003cmeta data-mint-head property=\"og:description\" content=\"Start the containers and confirm the instance is ready.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Kaneo Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://kaneo.app/docs/core/installation/start-services\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://kaneo.app/images/hero.png\">\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=\"Start and check Kaneo - Kaneo\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Start the containers and confirm the instance is ready.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://kaneo.app/images/hero.png\">\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=\"/docs/mintlify-assets/_mintlify/favicons/kaneo/eimVFFGnKRYPxM9e/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Kaneo\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#111111\">\u003clink data-mint-head rel=\"canonical\" href=\"https://kaneo.app/docs/core/installation/start-services\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/core/installation/start-services.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://kaneo.app/#organization\",\"name\":\"Kaneo\",\"url\":\"https://kaneo.app\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/kaneo/5yhrF9JhaeVdZ2IR/logo/dark.svg?fit=max\u0026auto=format\u0026n=5yhrF9JhaeVdZ2IR\u0026q=85\u0026s=8ca9f5b9fe8ca4d39a0ed648a4b06484\"}},{\"@type\":\"WebSite\",\"@id\":\"https://kaneo.app/docs#website\",\"name\":\"Kaneo\",\"url\":\"https://kaneo.app/docs\",\"publisher\":{\"@id\":\"https://kaneo.app/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://kaneo.app/docs/core/installation/start-services#webpage\",\"url\":\"https://kaneo.app/docs/core/installation/start-services\",\"name\":\"Start and check Kaneo\",\"description\":\"Start the containers and confirm the instance is ready.\",\"dateModified\":\"2026-09-26T19:56:55.221Z\",\"isPartOf\":{\"@id\":\"https://kaneo.app/docs#website\"}},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://kaneo.app/docs/core/installation/start-services#article\",\"headline\":\"Start and check Kaneo\",\"name\":\"Start and check Kaneo\",\"description\":\"Start the containers and confirm the instance is ready.\",\"url\":\"https://kaneo.app/docs/core/installation/start-services\",\"mainEntityOfPage\":{\"@id\":\"https://kaneo.app/docs/core/installation/start-services#webpage\"},\"image\":\"https://kaneo.app/images/hero.png\",\"dateModified\":\"2026-09-26T19:56:55.221Z\",\"publisher\":{\"@id\":\"https://kaneo.app/#organization\"},\"isPartOf\":{\"@id\":\"https://kaneo.app/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Kaneo\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Kaneo\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/docs/core/installation/start-services.md","siteName":"Kaneo","nav":{"global":{"anchors":[{"anchor":"Website","icon":"globe","href":"https://kaneo.app"},{"anchor":"GitHub","icon":"github","href":"https://github.com/usekaneo/kaneo"}]},"tabs":[{"tab":"Using Kaneo","groups":[{"group":"Start here","pages":[{"title":"Kaneo docs","href":""},{"title":"Your first project","href":"/core/index"},{"title":"Using Kaneo","href":"/core/functional/index"},{"title":"Workspaces and projects","href":"/core/functional/create-workspace-and-project"}]},{"group":"Work with tasks","pages":[{"title":"Board, List, and task details","href":"/core/functional/plan-and-execute-tasks"},{"title":"Backlog","href":"/core/functional/backlog-planning"},{"title":"Calendar and Gantt","href":"/core/functional/calendar-and-gantt"},{"title":"Workflows","href":"/core/functional/configure-workflows"},{"title":"Labels","href":"/core/functional/manage-workspace-labels"}]},{"group":"Your team and account","pages":[{"title":"Members and roles","href":"/core/functional/collaborate-with-team"},{"title":"Notifications","href":"/core/functional/account-notifications"},{"title":"Preferences","href":"/core/functional/personalize-your-workspace"},{"title":"Your account","href":"/core/functional/manage-your-account"},{"title":"Mobile app","href":"/core/functional/mobile-app"}]},{"group":"Import from other tools","pages":[{"title":"Import from other tools","href":"/core/migrations/index"},{"title":"Import from Linear","href":"/core/migrations/from-linear"},{"title":"Import from Jira","href":"/core/migrations/from-jira"},{"title":"Import from Trello","href":"/core/migrations/from-trello"},{"title":"Import from Plane","href":"/core/migrations/from-plane"},{"title":"Import from PLANKA","href":"/core/migrations/from-planka"},{"title":"Import from another Kaneo instance","href":"/core/migrations/from-kaneo"}]}]},{"tab":"Self-hosting","groups":[{"group":"Install","pages":[{"title":"Self-host Kaneo","href":"/core/installation"},{"title":"Install with Docker Compose","href":"/core/installation/docker-compose"},{"title":"Deploy with drim CLI","href":"/core/installation/drim"},{"title":"Deploy on Coolify","href":"/core/deployments/coolify"},{"title":"Deploy on Railway","href":"/core/deployments/railway"}]},{"group":"Configure","pages":[{"title":"Nginx and HTTPS","href":"/core/reverse-proxy/nginx"},{"title":"Files and uploads","href":"/core/installation/object-storage-and-image-uploads"},{"title":"Store files with Silo","href":"/core/installation/silo"},{"title":"AWS S3 and other providers","href":"/core/installation/storage-backends"},{"title":"Environment variables","href":"/core/installation/environment-variables"}]},{"group":"Sign-in providers","pages":[{"title":"Sign in with GitHub","href":"/core/social-providers/github"},{"title":"Sign in with Google","href":"/core/social-providers/google"},{"title":"Sign in with Discord","href":"/core/social-providers/discord"},{"title":"Custom OAuth/OIDC","href":"/core/social-providers/custom-oauth"}]},{"group":"Keep it running","pages":[{"title":"Administer your instance","href":"/core/operations/administration"},{"title":"Backups and recovery","href":"/core/operations/backups"},{"title":"Upgrade Kaneo","href":"/core/operations/upgrades"},{"title":"Upgrade PostgreSQL 16 to 18","href":"/core/operations/postgresql-18"},{"title":"Troubleshooting","href":"/core/operations/troubleshooting"}]},{"group":"Migrate a deployment","pages":[{"title":"Move to the bundled container","href":"/core/installation/migration"},{"title":"Use drim with an existing deployment","href":"/core/installation/drim-migration"}]}]},{"tab":"Integrations","groups":[{"group":"Overview","pages":[{"title":"Integrations","href":"/core/integrations"}]},{"group":"Repositories","pages":[{"title":"Set up the GitHub integration","href":"/core/integrations/github/setup"},{"title":"Connect a GitHub repository","href":"/core/integrations/github/configuration"},{"title":"GitHub troubleshooting","href":"/core/integrations/github/troubleshooting"},{"title":"Connect Gitea","href":"/core/integrations/gitea/setup"},{"title":"GitLab Setup","href":"/core/integrations/gitlab/setup"}]},{"group":"Team updates","pages":[{"title":"Slack","href":"/core/integrations/slack"},{"title":"Discord","href":"/core/integrations/discord"},{"title":"Mattermost","href":"/core/integrations/mattermost"},{"title":"Telegram","href":"/core/integrations/telegram"},{"title":"Outgoing webhooks","href":"/core/integrations/outgoing-webhooks"}]},{"group":"Personal notifications","pages":[{"title":"ntfy","href":"/core/integrations/ntfy"},{"title":"Gotify","href":"/core/integrations/gotify"},{"title":"Personal webhooks","href":"/core/integrations/personal-webhooks"}]},{"group":"AI assistants","pages":[{"title":"Kaneo MCP Server","href":"/core/integrations/mcp"}]}]},{"tab":"Developers","groups":[{"group":"Start building","pages":[{"title":"Make your first API request","href":"/api-reference/introduction"},{"title":"Authentication","href":"/api-reference/authentication"},{"title":"Errors","href":"/api-reference/errors"},{"title":"MCP protocol reference","href":"/core/integrations/mcp-stateless"}]},{"group":"Command line","pages":[{"title":"Kaneo CLI","sidebarTitle":"Overview","href":"/cli/index"},{"title":"Install the CLI","sidebarTitle":"Install","href":"/cli/install"},{"title":"Sign in","href":"/cli/sign-in"},{"title":"Configuration","href":"/cli/configuration"},{"title":"Scripts and agents","href":"/cli/scripting"},{"title":"CLI command reference","sidebarTitle":"Command reference","href":"/cli/reference"}]},{"group":"Endpoint reference","pages":[{"group":"Instance","pages":[{"title":"Get instance status","deprecated":null,"version":null,"openapi":"/openapi.json get /instance/status","href":"/api-reference/instance/get-instance-status"}]},{"group":"Projects","pages":[{"title":"Get a public project board","deprecated":null,"version":null,"openapi":"/openapi.json get /public-project/{id}","href":"/api-reference/projects/get-a-public-project-board"},{"title":"Read a public project description page","deprecated":null,"version":null,"openapi":"/openapi.json get /public-project/{id}/description","href":"/api-reference/projects/read-a-public-project-description-page"},{"title":"Read a public task description page","deprecated":null,"version":null,"openapi":"/openapi.json get /public-project/{id}/task/{taskId}/description","href":"/api-reference/projects/read-a-public-task-description-page"},{"title":"Move a project to another workspace","deprecated":null,"version":null,"openapi":"/openapi.json put /project/{id}/move","href":"/api-reference/projects/move-a-project-to-another-workspace"},{"title":"List projects","deprecated":null,"version":null,"openapi":"/openapi.json get /project","href":"/api-reference/projects/list-projects"},{"title":"Create project","deprecated":null,"version":null,"openapi":"/openapi.json post /project","href":"/api-reference/projects/create-project"},{"title":"Get project","deprecated":null,"version":null,"openapi":"/openapi.json get /project/{id}","href":"/api-reference/projects/get-project"},{"title":"Update project","deprecated":null,"version":null,"openapi":"/openapi.json put /project/{id}","href":"/api-reference/projects/update-project"},{"title":"Delete project","deprecated":null,"version":null,"openapi":"/openapi.json delete /project/{id}","href":"/api-reference/projects/delete-project"},{"title":"Download project background","deprecated":null,"version":null,"openapi":"/openapi.json get /project/{id}/background","href":"/api-reference/projects/download-project-background"},{"title":"Delete project background","deprecated":null,"version":null,"openapi":"/openapi.json delete /project/{id}/background","href":"/api-reference/projects/delete-project-background"},{"title":"Reorder projects","deprecated":null,"version":null,"openapi":"/openapi.json put /project/reorder","href":"/api-reference/projects/reorder-projects"},{"title":"Archive project","deprecated":null,"version":null,"openapi":"/openapi.json put /project/{id}/archive","href":"/api-reference/projects/archive-project"},{"title":"Unarchive project","deprecated":null,"version":null,"openapi":"/openapi.json put /project/{id}/unarchive","href":"/api-reference/projects/unarchive-project"},{"title":"Prepare project background upload","deprecated":null,"version":null,"openapi":"/openapi.json put /project/{id}/background-upload","href":"/api-reference/projects/prepare-project-background-upload"},{"title":"Finalize project background upload","deprecated":null,"version":null,"openapi":"/openapi.json post /project/{id}/background-upload/finalize","href":"/api-reference/projects/finalize-project-background-upload"}]},{"group":"Calendar feeds","pages":[{"title":"Subscribe to a calendar feed","deprecated":null,"version":null,"openapi":"/openapi.json get /calendar-feed/{token}/calendar.ics","href":"/api-reference/calendar-feeds/subscribe-to-a-calendar-feed"},{"title":"List project calendar feeds","deprecated":null,"version":null,"openapi":"/openapi.json get /calendar-feed/project/{projectId}","href":"/api-reference/calendar-feeds/list-project-calendar-feeds"},{"title":"Create a calendar feed","deprecated":null,"version":null,"openapi":"/openapi.json post /calendar-feed/project/{projectId}","href":"/api-reference/calendar-feeds/create-a-calendar-feed"},{"title":"Revoke a calendar feed","deprecated":null,"version":null,"openapi":"/openapi.json delete /calendar-feed/project/{projectId}/{id}","href":"/api-reference/calendar-feeds/revoke-a-calendar-feed"}]},{"group":"Authentication","pages":[{"title":"Get session","deprecated":null,"version":null,"openapi":"/openapi.json get /auth/get-session","href":"/api-reference/authentication/get-session"},{"title":"Device authorization page","deprecated":null,"version":null,"openapi":"/openapi.json get /auth/device","href":"/api-reference/authentication/device-authorization-page"},{"title":"Get OAuth id token","deprecated":null,"version":null,"openapi":"/openapi.json get /oauth/id-token","href":"/api-reference/authentication/get-oauth-id-token"}]},{"group":"Assets","pages":[{"title":"Download asset","deprecated":null,"version":null,"openapi":"/openapi.json get /asset/{id}","href":"/api-reference/assets/download-asset"}]},{"group":"User","pages":[{"title":"Download avatar","deprecated":null,"version":null,"openapi":"/openapi.json get /user/avatar/{id}","href":"/api-reference/user/download-avatar"},{"title":"Get current user","deprecated":null,"version":null,"openapi":"/openapi.json get /user/me","href":"/api-reference/user/get-current-user"},{"title":"Upload avatar","deprecated":null,"version":null,"openapi":"/openapi.json put /user/avatar","href":"/api-reference/user/upload-avatar"},{"title":"Delete avatar","deprecated":null,"version":null,"openapi":"/openapi.json delete /user/avatar","href":"/api-reference/user/delete-avatar"},{"title":"List your active sessions","deprecated":null,"version":null,"openapi":"/openapi.json get /user/sessions","href":"/api-reference/user/list-your-active-sessions"},{"title":"Sign out one of your sessions","deprecated":null,"version":null,"openapi":"/openapi.json delete /user/sessions/{sessionId}","href":"/api-reference/user/sign-out-one-of-your-sessions"}]},{"group":"Config","pages":[{"title":"Get config","deprecated":null,"version":null,"openapi":"/openapi.json get /config","href":"/api-reference/config/get-config"}]},{"group":"Organization Management","pages":[{"title":"Accept Organization Invitation","deprecated":null,"version":null,"openapi":"/openapi.json post /auth/organization/accept-invitation","href":"/api-reference/organization-management/accept-organization-invitation"},{"title":"Add Organization Team Member","deprecated":null,"version":null,"openapi":"/openapi.json post /auth/organization/add-team-member","href":"/api-reference/organization-management/add-organization-team-member"},{"title":"Cancel Organization Invitation","deprecated":null,"version":null,"openapi":"/openapi.json post /auth/organization/cancel-invitation","href":"/api-reference/organization-management/cancel-organization-invitation"},{"title":"Check Organization Slug","deprecated":null,"version":null,"openapi":"/openapi.json post /auth/organization/check-slug","href":"/api-reference/organization-management/check-organization-slug"},{"title":"Create Organization","deprecated":null,"version":null,"openapi":"/openapi.json post /auth/organization/create","href":"/api-reference/organization-management/create-organization"},{"title":"Create Organization Role","deprecated":null,"version":null,"openapi":"/openapi.json post /auth/organization/create-role","href":"/api-reference/organization-management/create-organization-role"},{"title":"Create Organization Team","deprecated":null,"version":null,"openapi":"/openapi.json post /auth/organization/create-team","href":"/api-reference/organization-management/create-organization-team"},{"title":"Delete Organization","deprecated":null,"version":null,"openapi":"/openapi.json post /auth/organization/delete","href":"/api-reference/organization-management/delete-organization"},{"title":"Delete Organization Role","deprecated":null,"version":null,"openapi":"/openapi.json post /auth/organization/delete-role","href":"/api-reference/organization-management/delete-organization-role"},{"title":"Get Organization Active Member","deprecated":null,"version":null,"openapi":"/openapi.json get /auth/organization/get-active-member","href":"/api-reference/organization-management/get-organization-active-member"},{"title":"Get Organization Active Member Role","deprecated":null,"version":null,"openapi":"/openapi.json get /auth/organization/get-active-member-role","href":"/api-reference/organization-management/get-organization-active-member-role"},{"title":"Get Organization Full Organization","deprecated":null,"version":null,"openapi":"/openapi.json get /auth/organization/get-full-organization","href":"/api-reference/organization-management/get-organization-full-organization"},{"title":"Get Organization Invitation","deprecated":null,"version":null,"openapi":"/openapi.json get /auth/organization/get-invitation","href":"/api-reference/organization-management/get-organization-invitation"},{"title":"Get Organization Role","deprecated":null,"version":null,"openapi":"/openapi.json get /auth/organization/get-role","href":"/api-reference/organization-management/get-organization-role"},{"title":"Check Organization Permission","deprecated":null,"version":null,"openapi":"/openapi.json post /auth/organization/has-permission","href":"/api-reference/organization-management/check-organization-permission"},{"title":"Invite Organization Member","deprecated":null,"version":null,"openapi":"/openapi.json post /auth/organization/invite-member","href":"/api-reference/organization-management/invite-organization-member"},{"title":"Leave Organization","deprecated":null,"version":null,"openapi":"/openapi.json post /auth/organization/leave","href":"/api-reference/organization-management/leave-organization"},{"title":"List Organization","deprecated":null,"version":null,"openapi":"/openapi.json get /auth/organization/list","href":"/api-reference/organization-management/list-organization"},{"title":"List Organization Invitations","deprecated":null,"version":null,"openapi":"/openapi.json get /auth/organization/list-invitations","href":"/api-reference/organization-management/list-organization-invitations"},{"title":"List Organization Members","deprecated":null,"version":null,"openapi":"/openapi.json get /auth/organization/list-members","href":"/api-reference/organization-management/list-organization-members"},{"title":"List Organization Roles","deprecated":null,"version":null,"openapi":"/openapi.json get /auth/organization/list-roles","href":"/api-reference/organization-management/list-organization-roles"},{"title":"List Organization Team Members","deprecated":null,"version":null,"openapi":"/openapi.json get /auth/organization/list-team-members","href":"/api-reference/organization-management/list-organization-team-members"},{"title":"List Organization Teams","deprecated":null,"version":null,"openapi":"/openapi.json get /auth/organization/list-teams","href":"/api-reference/organization-management/list-organization-teams"},{"title":"List Organization User Invitations","deprecated":null,"version":null,"openapi":"/openapi.json get /auth/organization/list-user-invitations","href":"/api-reference/organization-management/list-organization-user-invitations"},{"title":"List Organization User Teams","deprecated":null,"version":null,"openapi":"/openapi.json get /auth/organization/list-user-teams","href":"/api-reference/organization-management/list-organization-user-teams"},{"title":"Reject Organization Invitation","deprecated":null,"version":null,"openapi":"/openapi.json post /auth/organization/reject-invitation","href":"/api-reference/organization-management/reject-organization-invitation"},{"title":"Remove Organization Member","deprecated":null,"version":null,"openapi":"/openapi.json post /auth/organization/remove-member","href":"/api-reference/organization-management/remove-organization-member"},{"title":"Remove Organization Team","deprecated":null,"version":null,"openapi":"/openapi.json post /auth/organization/remove-team","href":"/api-reference/organization-management/remove-organization-team"},{"title":"Remove Organization Team Member","deprecated":null,"version":null,"openapi":"/openapi.json post /auth/organization/remove-team-member","href":"/api-reference/organization-management/remove-organization-team-member"},{"title":"Set Organization Active","deprecated":null,"version":null,"openapi":"/openapi.json post /auth/organization/set-active","href":"/api-reference/organization-management/set-organization-active"},{"title":"Set Organization Active Team","deprecated":null,"version":null,"openapi":"/openapi.json post /auth/organization/set-active-team","href":"/api-reference/organization-management/set-organization-active-team"},{"title":"Update Organization","deprecated":null,"version":null,"openapi":"/openapi.json post /auth/organization/update","href":"/api-reference/organization-management/update-organization"},{"title":"Update Organization Member Role","deprecated":null,"version":null,"openapi":"/openapi.json post /auth/organization/update-member-role","href":"/api-reference/organization-management/update-organization-member-role"},{"title":"Update Organization Role","deprecated":null,"version":null,"openapi":"/openapi.json post /auth/organization/update-role","href":"/api-reference/organization-management/update-organization-role"},{"title":"Update Organization Team","deprecated":null,"version":null,"openapi":"/openapi.json post /auth/organization/update-team","href":"/api-reference/organization-management/update-organization-team"}]},{"group":"MCP","pages":[{"title":"Register MCP OAuth client","deprecated":null,"version":null,"openapi":"/openapi.json post /mcp/register","href":"/api-reference/mcp/register-mcp-oauth-client"},{"title":"Start MCP authorization","deprecated":null,"version":null,"openapi":"/openapi.json get /mcp/authorize","href":"/api-reference/mcp/start-mcp-authorization"},{"title":"Get consent request","deprecated":null,"version":null,"openapi":"/openapi.json get /mcp/authorize/request/{requestId}","href":"/api-reference/mcp/get-consent-request"},{"title":"Decide consent request","deprecated":null,"version":null,"openapi":"/openapi.json post /mcp/authorize/request/{requestId}","href":"/api-reference/mcp/decide-consent-request"}]},{"group":"Tasks","pages":[{"title":"Read a description page","deprecated":null,"version":null,"openapi":"/openapi.json get /task/{id}/description","href":"/api-reference/tasks/read-a-description-page"},{"title":"Search descriptions omitted from task lists","deprecated":null,"version":null,"openapi":"/openapi.json get /task/description-matches/{projectId}","href":"/api-reference/tasks/search-descriptions-omitted-from-task-lists"},{"title":"List my assigned tasks","deprecated":null,"version":null,"openapi":"/openapi.json get /task/assigned","href":"/api-reference/tasks/list-my-assigned-tasks"},{"title":"List tasks","deprecated":null,"version":null,"openapi":"/openapi.json get /task/tasks/{projectId}","href":"/api-reference/tasks/list-tasks"},{"title":"Bulk update tasks","deprecated":null,"version":null,"openapi":"/openapi.json patch /task/bulk","href":"/api-reference/tasks/bulk-update-tasks"},{"title":"Stage a task attachment","deprecated":null,"version":null,"openapi":"/openapi.json post /task/draft-upload/{projectId}","href":"/api-reference/tasks/stage-a-task-attachment"},{"title":"Finalize a staged task attachment","deprecated":null,"version":null,"openapi":"/openapi.json post /task/draft-upload/{projectId}/finalize","href":"/api-reference/tasks/finalize-a-staged-task-attachment"},{"title":"Reorder or move cards","deprecated":null,"version":null,"openapi":"/openapi.json post /task/reorder","href":"/api-reference/tasks/reorder-or-move-cards"},{"title":"Create task","deprecated":null,"version":null,"openapi":"/openapi.json post /task/{projectId}","href":"/api-reference/tasks/create-task"},{"title":"Duplicate a task","deprecated":null,"version":null,"openapi":"/openapi.json post /task/duplicate/{id}","href":"/api-reference/tasks/duplicate-a-task"},{"title":"Get task by ticket ID","deprecated":null,"version":null,"openapi":"/openapi.json get /task/by-ticket-id/{ticketId}","href":"/api-reference/tasks/get-task-by-ticket-id"},{"title":"Get task","deprecated":null,"version":null,"openapi":"/openapi.json get /task/{id}","href":"/api-reference/tasks/get-task"},{"title":"Update task","deprecated":null,"version":null,"openapi":"/openapi.json put /task/{id}","href":"/api-reference/tasks/update-task"},{"title":"Delete task","deprecated":null,"version":null,"openapi":"/openapi.json delete /task/{id}","href":"/api-reference/tasks/delete-task"},{"title":"Move task","deprecated":null,"version":null,"openapi":"/openapi.json put /task/move/{id}","href":"/api-reference/tasks/move-task"},{"title":"Export tasks","deprecated":null,"version":null,"openapi":"/openapi.json get /task/export/{projectId}","href":"/api-reference/tasks/export-tasks"},{"title":"Import tasks","deprecated":null,"version":null,"openapi":"/openapi.json post /task/import/{projectId}","href":"/api-reference/tasks/import-tasks"},{"title":"Update task status","deprecated":null,"version":null,"openapi":"/openapi.json put /task/status/{id}","href":"/api-reference/tasks/update-task-status"},{"title":"Update task priority","deprecated":null,"version":null,"openapi":"/openapi.json put /task/priority/{id}","href":"/api-reference/tasks/update-task-priority"},{"title":"Update task assignee","deprecated":null,"version":null,"openapi":"/openapi.json put /task/assignee/{id}","href":"/api-reference/tasks/update-task-assignee"},{"title":"Update task due date","deprecated":null,"version":null,"openapi":"/openapi.json put /task/due-date/{id}","href":"/api-reference/tasks/update-task-due-date"},{"title":"Update task recurrence","deprecated":null,"version":null,"openapi":"/openapi.json put /task/recurrence/{id}","href":"/api-reference/tasks/update-task-recurrence"},{"title":"Update task title","deprecated":null,"version":null,"openapi":"/openapi.json put /task/title/{id}","href":"/api-reference/tasks/update-task-title"},{"title":"Create image upload URL","deprecated":null,"version":null,"openapi":"/openapi.json put /task/image-upload/{id}","href":"/api-reference/tasks/create-image-upload-url"},{"title":"Finalize image upload","deprecated":null,"version":null,"openapi":"/openapi.json post /task/image-upload/{id}/finalize","href":"/api-reference/tasks/finalize-image-upload"},{"title":"Update task description","deprecated":null,"version":null,"openapi":"/openapi.json put /task/description/{id}","href":"/api-reference/tasks/update-task-description"}]},{"group":"Columns","pages":[{"title":"Get columns","deprecated":null,"version":null,"openapi":"/openapi.json get /column/{projectId}","href":"/api-reference/columns/get-columns"},{"title":"Create column","deprecated":null,"version":null,"openapi":"/openapi.json post /column/{projectId}","href":"/api-reference/columns/create-column"},{"title":"Reorder columns","deprecated":null,"version":null,"openapi":"/openapi.json put /column/reorder/{projectId}","href":"/api-reference/columns/reorder-columns"},{"title":"Update column","deprecated":null,"version":null,"openapi":"/openapi.json put /column/{id}","href":"/api-reference/columns/update-column"},{"title":"Delete column","deprecated":null,"version":null,"openapi":"/openapi.json delete /column/{id}","href":"/api-reference/columns/delete-column"}]},{"group":"Activity","pages":[{"title":"Get recent workspace activity","deprecated":null,"version":null,"openapi":"/openapi.json get /activity/workspace/{workspaceId}","href":"/api-reference/activity/get-recent-workspace-activity"},{"title":"Get task activity","deprecated":null,"version":null,"openapi":"/openapi.json get /activity/{taskId}","href":"/api-reference/activity/get-task-activity"},{"title":"Create activity","deprecated":null,"version":null,"openapi":"/openapi.json post /activity/create","href":"/api-reference/activity/create-activity"},{"title":"Update comment","deprecated":null,"version":null,"openapi":"/openapi.json put /activity/comment","href":"/api-reference/activity/update-comment"},{"title":"Create comment","deprecated":null,"version":null,"openapi":"/openapi.json post /activity/comment","href":"/api-reference/activity/create-comment"},{"title":"Delete comment","deprecated":null,"version":null,"openapi":"/openapi.json delete /activity/comment","href":"/api-reference/activity/delete-comment"}]},{"group":"Comments","pages":[{"title":"Get task comments","deprecated":null,"version":null,"openapi":"/openapi.json get /comment/{taskId}","href":"/api-reference/comments/get-task-comments"},{"title":"Create task comment","deprecated":null,"version":null,"openapi":"/openapi.json post /comment/{taskId}","href":"/api-reference/comments/create-task-comment"},{"title":"Update task comment","deprecated":null,"version":null,"openapi":"/openapi.json put /comment/{id}","href":"/api-reference/comments/update-task-comment"},{"title":"Delete task comment","deprecated":null,"version":null,"openapi":"/openapi.json delete /comment/{id}","href":"/api-reference/comments/delete-task-comment"}]},{"group":"Time Entries","pages":[{"title":"Get task time entries","deprecated":null,"version":null,"openapi":"/openapi.json get /time-entry/task/{taskId}","href":"/api-reference/time-entries/get-task-time-entries"},{"title":"Get time entry","deprecated":null,"version":null,"openapi":"/openapi.json get /time-entry/{id}","href":"/api-reference/time-entries/get-time-entry"},{"title":"Update time entry","deprecated":null,"version":null,"openapi":"/openapi.json put /time-entry/{id}","href":"/api-reference/time-entries/update-time-entry"},{"title":"Create time entry","deprecated":null,"version":null,"openapi":"/openapi.json post /time-entry","href":"/api-reference/time-entries/create-time-entry"}]},{"group":"Labels","pages":[{"title":"Get task labels","deprecated":null,"version":null,"openapi":"/openapi.json get /label/task/{taskId}","href":"/api-reference/labels/get-task-labels"},{"title":"Get workspace labels","deprecated":null,"version":null,"openapi":"/openapi.json get /label/workspace/{workspaceId}","href":"/api-reference/labels/get-workspace-labels"},{"title":"Create label","deprecated":null,"version":null,"openapi":"/openapi.json post /label","href":"/api-reference/labels/create-label"},{"title":"Get label","deprecated":null,"version":null,"openapi":"/openapi.json get /label/{id}","href":"/api-reference/labels/get-label"},{"title":"Update label","deprecated":null,"version":null,"openapi":"/openapi.json put /label/{id}","href":"/api-reference/labels/update-label"},{"title":"Delete label","deprecated":null,"version":null,"openapi":"/openapi.json delete /label/{id}","href":"/api-reference/labels/delete-label"},{"title":"Attach label to task","deprecated":null,"version":null,"openapi":"/openapi.json put /label/{id}/task","href":"/api-reference/labels/attach-label-to-task"},{"title":"Detach label from task","deprecated":null,"version":null,"openapi":"/openapi.json delete /label/{id}/task","href":"/api-reference/labels/detach-label-from-task"}]},{"group":"Notifications","pages":[{"title":"List notifications","deprecated":null,"version":null,"openapi":"/openapi.json get /notification","href":"/api-reference/notifications/list-notifications"},{"title":"Create notification","deprecated":null,"version":null,"openapi":"/openapi.json post /notification","href":"/api-reference/notifications/create-notification"},{"title":"Mark notification read","deprecated":null,"version":null,"openapi":"/openapi.json patch /notification/{id}/read","href":"/api-reference/notifications/mark-notification-read"},{"title":"Mark notification unread","deprecated":null,"version":null,"openapi":"/openapi.json patch /notification/{id}/unread","href":"/api-reference/notifications/mark-notification-unread"},{"title":"Mark all read","deprecated":null,"version":null,"openapi":"/openapi.json patch /notification/read-all","href":"/api-reference/notifications/mark-all-read"},{"title":"Clear all","deprecated":null,"version":null,"openapi":"/openapi.json delete /notification/clear-all","href":"/api-reference/notifications/clear-all"},{"title":"Clear read notifications","deprecated":null,"version":null,"openapi":"/openapi.json delete /notification/clear-read","href":"/api-reference/notifications/clear-read-notifications"},{"title":"Delete notification","deprecated":null,"version":null,"openapi":"/openapi.json delete /notification/{id}","href":"/api-reference/notifications/delete-notification"}]},{"group":"Notification Preferences","pages":[{"title":"Get notification preferences","deprecated":null,"version":null,"openapi":"/openapi.json get /notification-preferences","href":"/api-reference/notification-preferences/get-notification-preferences"},{"title":"Update notification preferences","deprecated":null,"version":null,"openapi":"/openapi.json put /notification-preferences","href":"/api-reference/notification-preferences/update-notification-preferences"},{"title":"Upsert workspace rule","deprecated":null,"version":null,"openapi":"/openapi.json put /notification-preferences/workspaces/{workspaceId}","href":"/api-reference/notification-preferences/upsert-workspace-rule"},{"title":"Delete workspace rule","deprecated":null,"version":null,"openapi":"/openapi.json delete /notification-preferences/workspaces/{workspaceId}","href":"/api-reference/notification-preferences/delete-workspace-rule"}]},{"group":"Search","pages":[{"title":"Global search","deprecated":null,"version":null,"openapi":"/openapi.json get /search","href":"/api-reference/search/global-search"}]},{"group":"Integration sync","pages":[{"title":"Get sync rules and current task scope","deprecated":null,"version":null,"openapi":"/openapi.json get /integration-sync/project/{projectId}/{provider}","href":"/api-reference/integration-sync/get-sync-rules-and-current-task-scope"},{"title":"Apply a previewed sync rule","deprecated":null,"version":null,"openapi":"/openapi.json patch /integration-sync/project/{projectId}/{provider}","href":"/api-reference/integration-sync/apply-a-previewed-sync-rule"},{"title":"Preview a sync rule change","deprecated":null,"version":null,"openapi":"/openapi.json post /integration-sync/project/{projectId}/{provider}/preview","href":"/api-reference/integration-sync/preview-a-sync-rule-change"},{"title":"Compare a paused task with its external issue","deprecated":null,"version":null,"openapi":"/openapi.json get /integration-sync/project/{projectId}/{provider}/links/{linkId}/review","href":"/api-reference/integration-sync/compare-a-paused-task-with-its-external-issue"},{"title":"Resume a reviewed issue link","deprecated":null,"version":null,"openapi":"/openapi.json post /integration-sync/project/{projectId}/{provider}/links/{linkId}/resume","href":"/api-reference/integration-sync/resume-a-reviewed-issue-link"}]},{"group":"GitHub","pages":[{"title":"Get GitHub app info","deprecated":null,"version":null,"openapi":"/openapi.json get /github-integration/app-info","href":"/api-reference/github/get-github-app-info"},{"title":"List GitHub repositories","deprecated":null,"version":null,"openapi":"/openapi.json get /github-integration/repositories/{projectId}","href":"/api-reference/github/list-github-repositories"},{"title":"Verify GitHub installation","deprecated":null,"version":null,"openapi":"/openapi.json post /github-integration/verify","href":"/api-reference/github/verify-github-installation"},{"title":"Get GitHub integration","deprecated":null,"version":null,"openapi":"/openapi.json get /github-integration/project/{projectId}","href":"/api-reference/github/get-github-integration"},{"title":"Create GitHub integration","deprecated":null,"version":null,"openapi":"/openapi.json post /github-integration/project/{projectId}","href":"/api-reference/github/create-github-integration"},{"title":"Delete GitHub integration","deprecated":null,"version":null,"openapi":"/openapi.json delete /github-integration/project/{projectId}","href":"/api-reference/github/delete-github-integration"},{"title":"Update GitHub integration","deprecated":null,"version":null,"openapi":"/openapi.json patch /github-integration/project/{projectId}","href":"/api-reference/github/update-github-integration"},{"title":"Import GitHub issues","deprecated":null,"version":null,"openapi":"/openapi.json post /github-integration/import-issues","href":"/api-reference/github/import-github-issues"}]},{"group":"Gitea","pages":[{"title":"List Gitea repositories","deprecated":null,"version":null,"openapi":"/openapi.json post /gitea-integration/repositories","href":"/api-reference/gitea/list-gitea-repositories"},{"title":"Verify Gitea access","deprecated":null,"version":null,"openapi":"/openapi.json post /gitea-integration/verify","href":"/api-reference/gitea/verify-gitea-access"},{"title":"Get Gitea integration","deprecated":null,"version":null,"openapi":"/openapi.json get /gitea-integration/project/{projectId}","href":"/api-reference/gitea/get-gitea-integration"},{"title":"Create Gitea integration","deprecated":null,"version":null,"openapi":"/openapi.json post /gitea-integration/project/{projectId}","href":"/api-reference/gitea/create-gitea-integration"},{"title":"Delete Gitea integration","deprecated":null,"version":null,"openapi":"/openapi.json delete /gitea-integration/project/{projectId}","href":"/api-reference/gitea/delete-gitea-integration"},{"title":"Update Gitea integration","deprecated":null,"version":null,"openapi":"/openapi.json patch /gitea-integration/project/{projectId}","href":"/api-reference/gitea/update-gitea-integration"},{"title":"Import Gitea issues","deprecated":null,"version":null,"openapi":"/openapi.json post /gitea-integration/import-issues","href":"/api-reference/gitea/import-gitea-issues"}]},{"group":"GitLab","pages":[{"title":"List GitLab projects","deprecated":null,"version":null,"openapi":"/openapi.json post /gitlab-integration/projects","href":"/api-reference/gitlab/list-gitlab-projects"},{"title":"Verify GitLab access","deprecated":null,"version":null,"openapi":"/openapi.json post /gitlab-integration/verify","href":"/api-reference/gitlab/verify-gitlab-access"},{"title":"Get GitLab integration","deprecated":null,"version":null,"openapi":"/openapi.json get /gitlab-integration/project/{projectId}","href":"/api-reference/gitlab/get-gitlab-integration"},{"title":"Create GitLab integration","deprecated":null,"version":null,"openapi":"/openapi.json post /gitlab-integration/project/{projectId}","href":"/api-reference/gitlab/create-gitlab-integration"},{"title":"Delete GitLab integration","deprecated":null,"version":null,"openapi":"/openapi.json delete /gitlab-integration/project/{projectId}","href":"/api-reference/gitlab/delete-gitlab-integration"},{"title":"Update GitLab integration","deprecated":null,"version":null,"openapi":"/openapi.json patch /gitlab-integration/project/{projectId}","href":"/api-reference/gitlab/update-gitlab-integration"},{"title":"Import GitLab issues","deprecated":null,"version":null,"openapi":"/openapi.json post /gitlab-integration/import-issues","href":"/api-reference/gitlab/import-gitlab-issues"}]},{"group":"Generic Webhook","pages":[{"title":"Get webhook integration","deprecated":null,"version":null,"openapi":"/openapi.json get /generic-webhook-integration/project/{projectId}","href":"/api-reference/generic-webhook/get-webhook-integration"},{"title":"Create webhook integration","deprecated":null,"version":null,"openapi":"/openapi.json post /generic-webhook-integration/project/{projectId}","href":"/api-reference/generic-webhook/create-webhook-integration"},{"title":"Delete webhook integration","deprecated":null,"version":null,"openapi":"/openapi.json delete /generic-webhook-integration/project/{projectId}","href":"/api-reference/generic-webhook/delete-webhook-integration"},{"title":"Update webhook integration","deprecated":null,"version":null,"openapi":"/openapi.json patch /generic-webhook-integration/project/{projectId}","href":"/api-reference/generic-webhook/update-webhook-integration"}]},{"group":"Discord","pages":[{"title":"Get Discord integration","deprecated":null,"version":null,"openapi":"/openapi.json get /discord-integration/project/{projectId}","href":"/api-reference/discord/get-discord-integration"},{"title":"Create Discord integration","deprecated":null,"version":null,"openapi":"/openapi.json post /discord-integration/project/{projectId}","href":"/api-reference/discord/create-discord-integration"},{"title":"Delete Discord integration","deprecated":null,"version":null,"openapi":"/openapi.json delete /discord-integration/project/{projectId}","href":"/api-reference/discord/delete-discord-integration"},{"title":"Update Discord integration","deprecated":null,"version":null,"openapi":"/openapi.json patch /discord-integration/project/{projectId}","href":"/api-reference/discord/update-discord-integration"}]},{"group":"Mattermost","pages":[{"title":"Get Mattermost integration","deprecated":null,"version":null,"openapi":"/openapi.json get /mattermost-integration/project/{projectId}","href":"/api-reference/mattermost/get-mattermost-integration"},{"title":"Create Mattermost integration","deprecated":null,"version":null,"openapi":"/openapi.json post /mattermost-integration/project/{projectId}","href":"/api-reference/mattermost/create-mattermost-integration"},{"title":"Delete Mattermost integration","deprecated":null,"version":null,"openapi":"/openapi.json delete /mattermost-integration/project/{projectId}","href":"/api-reference/mattermost/delete-mattermost-integration"},{"title":"Update Mattermost integration","deprecated":null,"version":null,"openapi":"/openapi.json patch /mattermost-integration/project/{projectId}","href":"/api-reference/mattermost/update-mattermost-integration"}]},{"group":"Slack","pages":[{"title":"Get Slack integration","deprecated":null,"version":null,"openapi":"/openapi.json get /slack-integration/project/{projectId}","href":"/api-reference/slack/get-slack-integration"},{"title":"Create Slack integration","deprecated":null,"version":null,"openapi":"/openapi.json post /slack-integration/project/{projectId}","href":"/api-reference/slack/create-slack-integration"},{"title":"Delete Slack integration","deprecated":null,"version":null,"openapi":"/openapi.json delete /slack-integration/project/{projectId}","href":"/api-reference/slack/delete-slack-integration"},{"title":"Update Slack integration","deprecated":null,"version":null,"openapi":"/openapi.json patch /slack-integration/project/{projectId}","href":"/api-reference/slack/update-slack-integration"}]},{"group":"Telegram","pages":[{"title":"Get Telegram integration","deprecated":null,"version":null,"openapi":"/openapi.json get /telegram-integration/project/{projectId}","href":"/api-reference/telegram/get-telegram-integration"},{"title":"Create Telegram integration","deprecated":null,"version":null,"openapi":"/openapi.json post /telegram-integration/project/{projectId}","href":"/api-reference/telegram/create-telegram-integration"},{"title":"Delete Telegram integration","deprecated":null,"version":null,"openapi":"/openapi.json delete /telegram-integration/project/{projectId}","href":"/api-reference/telegram/delete-telegram-integration"},{"title":"Update Telegram integration","deprecated":null,"version":null,"openapi":"/openapi.json patch /telegram-integration/project/{projectId}","href":"/api-reference/telegram/update-telegram-integration"}]},{"group":"Task Relations","pages":[{"title":"Get a project's task relations","deprecated":null,"version":null,"openapi":"/openapi.json get /task-relation/project/{projectId}","href":"/api-reference/task-relations/get-a-projects-task-relations"},{"title":"Get task relations","deprecated":null,"version":null,"openapi":"/openapi.json get /task-relation/{taskId}","href":"/api-reference/task-relations/get-task-relations"},{"title":"Create task relation","deprecated":null,"version":null,"openapi":"/openapi.json post /task-relation","href":"/api-reference/task-relations/create-task-relation"},{"title":"Delete task relation","deprecated":null,"version":null,"openapi":"/openapi.json delete /task-relation/{id}","href":"/api-reference/task-relations/delete-task-relation"}]},{"group":"External Links","pages":[{"title":"Get task external links","deprecated":null,"version":null,"openapi":"/openapi.json get /external-link/task/{taskId}","href":"/api-reference/external-links/get-task-external-links"},{"title":"Create an external link","deprecated":null,"version":null,"openapi":"/openapi.json post /external-link/task/{taskId}","href":"/api-reference/external-links/create-an-external-link"},{"title":"Remove a manual resource link","deprecated":null,"version":null,"openapi":"/openapi.json delete /external-link/task/{taskId}/{id}","href":"/api-reference/external-links/remove-a-manual-resource-link"},{"title":"Update a manual link","deprecated":null,"version":null,"openapi":"/openapi.json patch /external-link/task/{taskId}/{id}","href":"/api-reference/external-links/update-a-manual-link"}]},{"group":"Workflow Rules","pages":[{"title":"Get workflow rules","deprecated":null,"version":null,"openapi":"/openapi.json get /workflow-rule/{projectId}","href":"/api-reference/workflow-rules/get-workflow-rules"},{"title":"Upsert workflow rule","deprecated":null,"version":null,"openapi":"/openapi.json put /workflow-rule/{projectId}","href":"/api-reference/workflow-rules/upsert-workflow-rule"},{"title":"Delete workflow rule","deprecated":null,"version":null,"openapi":"/openapi.json delete /workflow-rule/{id}","href":"/api-reference/workflow-rules/delete-workflow-rule"}]},{"group":"Invitations","pages":[{"title":"Get pending invitations","deprecated":null,"version":null,"openapi":"/openapi.json get /invitation/pending","href":"/api-reference/invitations/get-pending-invitations"},{"title":"Get invitation details","deprecated":null,"version":null,"openapi":"/openapi.json get /invitation/{id}","href":"/api-reference/invitations/get-invitation-details"}]},{"group":"Workspaces","pages":[{"title":"List workspaces","deprecated":null,"version":null,"openapi":"/openapi.json get /workspace","href":"/api-reference/workspaces/list-workspaces"},{"title":"Get workspace","deprecated":null,"version":null,"openapi":"/openapi.json get /workspace/{workspaceId}","href":"/api-reference/workspaces/get-workspace"},{"title":"Get workspace members","deprecated":null,"version":null,"openapi":"/openapi.json get /workspace/{workspaceId}/members","href":"/api-reference/workspaces/get-workspace-members"},{"title":"Get my project access","deprecated":null,"version":null,"openapi":"/openapi.json get /workspace/{workspaceId}/project-access/me","href":"/api-reference/workspaces/get-my-project-access"},{"title":"Get my workspace capabilities","deprecated":null,"version":null,"openapi":"/openapi.json get /workspace/{workspaceId}/capabilities","href":"/api-reference/workspaces/get-my-workspace-capabilities"},{"title":"Get member project access","deprecated":null,"version":null,"openapi":"/openapi.json get /workspace/{workspaceId}/project-access","href":"/api-reference/workspaces/get-member-project-access"},{"title":"Update member project access","deprecated":null,"version":null,"openapi":"/openapi.json put /workspace/{workspaceId}/members/{userId}/project-access","href":"/api-reference/workspaces/update-member-project-access"}]},{"group":"Custom Fields","pages":[{"title":"Get custom fields","deprecated":null,"version":null,"openapi":"/openapi.json get /custom-field/project/{projectId}","href":"/api-reference/custom-fields/get-custom-fields"},{"title":"Get project custom field values","deprecated":null,"version":null,"openapi":"/openapi.json get /custom-field/project/{projectId}/values","href":"/api-reference/custom-fields/get-project-custom-field-values"},{"title":"Get task custom field values","deprecated":null,"version":null,"openapi":"/openapi.json get /custom-field/task/{taskId}","href":"/api-reference/custom-fields/get-task-custom-field-values"},{"title":"Get custom field filter values","deprecated":null,"version":null,"openapi":"/openapi.json get /custom-field/project/{projectId}/filter-values","href":"/api-reference/custom-fields/get-custom-field-filter-values"},{"title":"Create custom field","deprecated":null,"version":null,"openapi":"/openapi.json post /custom-field","href":"/api-reference/custom-fields/create-custom-field"},{"title":"Reorder custom fields","deprecated":null,"version":null,"openapi":"/openapi.json put /custom-field/reorder/{projectId}","href":"/api-reference/custom-fields/reorder-custom-fields"},{"title":"Set custom field value","deprecated":null,"version":null,"openapi":"/openapi.json put /custom-field/value","href":"/api-reference/custom-fields/set-custom-field-value"},{"title":"Update custom field","deprecated":null,"version":null,"openapi":"/openapi.json put /custom-field/{id}","href":"/api-reference/custom-fields/update-custom-field"},{"title":"Delete custom field","deprecated":null,"version":null,"openapi":"/openapi.json delete /custom-field/{id}","href":"/api-reference/custom-fields/delete-custom-field"}]},{"group":"Import","pages":[{"title":"List projects in an import source","deprecated":null,"version":null,"openapi":"/openapi.json post /import/projects","href":"/api-reference/import/list-projects-in-an-import-source"},{"title":"Start an import","deprecated":null,"version":null,"openapi":"/openapi.json post /import/runs","href":"/api-reference/import/start-an-import"},{"title":"List imports","deprecated":null,"version":null,"openapi":"/openapi.json get /import/runs/{workspaceId}","href":"/api-reference/import/list-imports"},{"title":"Get the Trello authorize link","deprecated":null,"version":null,"openapi":"/openapi.json get /import/trello/authorize-url/{workspaceId}","href":"/api-reference/import/get-the-trello-authorize-link"},{"title":"Get an import","deprecated":null,"version":null,"openapi":"/openapi.json get /import/runs/{workspaceId}/{runId}","href":"/api-reference/import/get-an-import"}]},{"group":"Admin","pages":[{"title":"Get the administration overview","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/overview","href":"/api-reference/admin/get-the-administration-overview"},{"title":"Get your instance permissions","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/access","href":"/api-reference/admin/get-your-instance-permissions"},{"title":"List instance users","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/users","href":"/api-reference/admin/list-instance-users"},{"title":"Create a user","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/users","href":"/api-reference/admin/create-a-user"},{"title":"List instance workspaces","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/workspaces","href":"/api-reference/admin/list-instance-workspaces"},{"title":"List workspace members","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/workspaces/{workspaceId}/members","href":"/api-reference/admin/list-workspace-members"},{"title":"Add a user to a workspace","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/workspaces/{workspaceId}/members","href":"/api-reference/admin/add-a-user-to-a-workspace"},{"title":"List assignable workspace roles","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/workspaces/{workspaceId}/roles","href":"/api-reference/admin/list-assignable-workspace-roles"},{"title":"Change a workspace member's role","deprecated":null,"version":null,"openapi":"/openapi.json put /admin/workspaces/{workspaceId}/members/{userId}/role","href":"/api-reference/admin/change-a-workspace-members-role"},{"title":"Remove a workspace member","deprecated":null,"version":null,"openapi":"/openapi.json delete /admin/workspaces/{workspaceId}/members/{userId}","href":"/api-reference/admin/remove-a-workspace-member"},{"title":"Get system status","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/system","href":"/api-reference/admin/get-system-status"},{"title":"Send a test email","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/system/test-email","href":"/api-reference/admin/send-a-test-email"},{"title":"Transfer workspace ownership","deprecated":null,"version":null,"openapi":"/openapi.json put /admin/workspaces/{workspaceId}/owner","href":"/api-reference/admin/transfer-workspace-ownership"},{"title":"Archive a workspace","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/workspaces/{workspaceId}/archive","href":"/api-reference/admin/archive-a-workspace"},{"title":"Restore an archived workspace","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/workspaces/{workspaceId}/restore","href":"/api-reference/admin/restore-an-archived-workspace"},{"title":"Delete a workspace","deprecated":null,"version":null,"openapi":"/openapi.json delete /admin/workspaces/{workspaceId}","href":"/api-reference/admin/delete-a-workspace"},{"title":"List the admin audit log","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/audit-log","href":"/api-reference/admin/list-the-admin-audit-log"},{"title":"Email a password reset link","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/users/{userId}/password-reset-email","href":"/api-reference/admin/email-a-password-reset-link"},{"title":"Email a verification link","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/users/{userId}/verification-email","href":"/api-reference/admin/email-a-verification-link"},{"title":"Mark an email as verified","deprecated":null,"version":null,"openapi":"/openapi.json put /admin/users/{userId}/email-verified","href":"/api-reference/admin/mark-an-email-as-verified"},{"title":"Set a user's avatar","deprecated":null,"version":null,"openapi":"/openapi.json put /admin/users/{userId}/avatar","href":"/api-reference/admin/set-a-users-avatar"},{"title":"Remove a user's avatar","deprecated":null,"version":null,"openapi":"/openapi.json delete /admin/users/{userId}/avatar","href":"/api-reference/admin/remove-a-users-avatar"},{"title":"Delete a user","deprecated":null,"version":null,"openapi":"/openapi.json delete /admin/users/{userId}","href":"/api-reference/admin/delete-a-user"},{"title":"Update a user","deprecated":null,"version":null,"openapi":"/openapi.json patch /admin/users/{userId}","href":"/api-reference/admin/update-a-user"},{"title":"Deactivate a user","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/users/{userId}/deactivate","href":"/api-reference/admin/deactivate-a-user"},{"title":"Reactivate a user","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/users/{userId}/reactivate","href":"/api-reference/admin/reactivate-a-user"},{"title":"List custom instance roles","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/roles","href":"/api-reference/admin/list-custom-instance-roles"},{"title":"Create a custom instance role","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/roles","href":"/api-reference/admin/create-a-custom-instance-role"},{"title":"Update a custom instance role","deprecated":null,"version":null,"openapi":"/openapi.json put /admin/roles/{roleId}","href":"/api-reference/admin/update-a-custom-instance-role"},{"title":"Delete a custom instance role","deprecated":null,"version":null,"openapi":"/openapi.json delete /admin/roles/{roleId}","href":"/api-reference/admin/delete-a-custom-instance-role"},{"title":"Get instance settings","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/settings","href":"/api-reference/admin/get-instance-settings"},{"title":"Update instance settings","deprecated":null,"version":null,"openapi":"/openapi.json patch /admin/settings","href":"/api-reference/admin/update-instance-settings"},{"title":"List instance webhooks","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/webhooks","href":"/api-reference/admin/list-instance-webhooks"},{"title":"Create an instance webhook","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/webhooks","href":"/api-reference/admin/create-an-instance-webhook"},{"title":"Update an instance webhook","deprecated":null,"version":null,"openapi":"/openapi.json put /admin/webhooks/{webhookId}","href":"/api-reference/admin/update-an-instance-webhook"},{"title":"Delete an instance webhook","deprecated":null,"version":null,"openapi":"/openapi.json delete /admin/webhooks/{webhookId}","href":"/api-reference/admin/delete-an-instance-webhook"},{"title":"Rotate a webhook signing secret","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/webhooks/{webhookId}/rotate-secret","href":"/api-reference/admin/rotate-a-webhook-signing-secret"},{"title":"Queue a test webhook delivery","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/webhooks/{webhookId}/test","href":"/api-reference/admin/queue-a-test-webhook-delivery"},{"title":"List recent webhook deliveries","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/webhooks/{webhookId}/deliveries","href":"/api-reference/admin/list-recent-webhook-deliveries"},{"title":"List a user's sessions","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/users/{userId}/sessions","href":"/api-reference/admin/list-a-users-sessions"},{"title":"Sign out all of a user's sessions","deprecated":null,"version":null,"openapi":"/openapi.json delete /admin/users/{userId}/sessions","href":"/api-reference/admin/sign-out-all-of-a-users-sessions"},{"title":"Sign out one of a user's sessions","deprecated":null,"version":null,"openapi":"/openapi.json delete /admin/users/{userId}/sessions/{sessionId}","href":"/api-reference/admin/sign-out-one-of-a-users-sessions"},{"title":"List a user's API keys","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/users/{userId}/api-keys","href":"/api-reference/admin/list-a-users-api-keys"},{"title":"Revoke a user's API key","deprecated":null,"version":null,"openapi":"/openapi.json delete /admin/users/{userId}/api-keys/{apiKeyId}","href":"/api-reference/admin/revoke-a-users-api-key"}]}]}]}]},"basePath":"","title":"Start and check Kaneo - Kaneo","deploymentId":"dpl_J2QdBVuN65x4CCtpqPb371YPt4xi","buildId":"dpl_J2QdBVuN65x4CCtpqPb371YPt4xi","dynamics":[],"chunks":[]}