--- title: Confluence On Prem API Integration on Truto slug: confluenceonprem category: Knowledge Management canonical: "https://truto.one/integrations/detail/confluenceonprem/" --- # Confluence On Prem API Integration on Truto **Category:** Knowledge Management **Status:** Beta ## Unified APIs ### Unified Knowledge Base API - **Page-Content** — Represents the content of a page - **Pages** — Represents the pages, posts, articles in a knowledge base - **Spaces** — Represents the high level grouping of pages in a knowledge base ### Unified User Directory API - **Activities** — Activities are the actions performed by users in the source application. - **Groups** — Groups are a collection of users in the source application. In some applications, they might also be called Teams. - **Me** — - **Users** — The User object represents a User. ### Unified Search API - **Search** — Search endpoint for all the apps. ## How it works 1. **Link your customer's Confluence On Prem account.** Use Truto's frontend SDK; we handle every OAuth and API key flow so you don't need to create the OAuth app. 2. **Authentication is automatic.** Truto refreshes tokens, stores credentials securely, and injects them into every API request. 3. **Call Truto's API to reach Confluence On Prem .** The Proxy API is a 1-to-1 mapping of the Confluence On Prem API. 4. **Get a unified response format.** Every response uses a single shape, with cursor-based pagination and data in the `result` field. ## Use cases - **Power AI-driven knowledge retrieval from on-prem documentation** — SaaS companies building AI copilots or enterprise search products need to ingest Confluence Data Center pages and content to fuel RAG pipelines — without asking customers to migrate sensitive docs to the cloud. - **Surface internal knowledge base articles inside support tools** — Helpdesk and customer support SaaS platforms can query a customer's on-prem Confluence spaces in real time, surfacing relevant troubleshooting guides directly in the agent's workflow to reduce resolution time. - **Automate documentation creation from external workflows** — Incident management, project management, and DevOps SaaS products can programmatically create and update Confluence pages — such as post-incident reviews or release notes — eliminating manual documentation overhead for engineering teams. - **Enforce permission-aware search across enterprise knowledge** — SaaS products that index Confluence content need to map on-prem users and groups to their own identity model so that search results respect the customer's existing access controls, a hard requirement in regulated industries. - **Sync Confluence spaces into developer portals and internal platforms** — Internal developer platform SaaS tools can pull runbooks, architecture docs, and API specs from Confluence Data Center and present them alongside CI/CD pipelines, keeping developer context centralized. ## What you can build - **Incremental page content sync pipeline** — Bulk-fetch all pages and page content from selected Confluence spaces, then use activity tracking to incrementally sync only changed documents into your search index or AI model. - **CQL-powered contextual knowledge sidebar** — Fire Confluence Query Language searches via the Unified Search API to populate a sidebar in your product with the most relevant on-prem knowledge base articles based on ticket or conversation context. - **Automated post-incident page generation** — Create new Confluence pages from structured templates when events occur in your product — such as resolved incidents or completed sprints — posted directly into the customer's designated space. - **Permission-aware identity mapping layer** — Use the Unified User Directory API to read users and groups from Confluence Data Center and map them to your product's access model, ensuring end users only see content they're authorized to view on-prem. - **Space and page browser for admin configuration** — Let your customer's admin browse and select which Confluence spaces and page hierarchies to sync, using the Unified Knowledge Base API's Spaces and Pages resources to build an intuitive setup flow. - **User activity feed for change detection** — Poll the Activities resource from the Unified User Directory API to detect recent page edits and new content, triggering re-indexing or notifications in your product without full re-syncs. ## FAQs ### How does authentication work for Confluence On-Prem (Data Center) integrations? Confluence Data Center typically supports HTTP basic authentication (username + API token or password) and, for newer versions, personal access tokens. Because the instance is self-hosted, Truto handles connectivity to the customer's on-prem environment, including scenarios where the instance is behind a firewall. ### Which Unified APIs does Truto provide for Confluence On-Prem? Truto maps Confluence On-Prem to three Unified APIs: the Unified Knowledge Base API (Spaces, Pages, Page-Content), the Unified User Directory API (Users, Groups, Me, Activities), and the Unified Search API (Search). No provider-specific tools are pre-built yet — additional capabilities are built on request. ### Can I use Confluence Query Language (CQL) through Truto's Unified Search API? Yes. The Unified Search API's Search resource allows you to pass CQL queries to Confluence Data Center, enabling precise filtering by labels, spaces, authors, and content text — the same query syntax Confluence natively supports. ### How does Truto handle pagination when fetching large volumes of pages? Truto abstracts Confluence's cursor-based pagination internally. When you list pages or search results through the Unified API, Truto manages the pagination tokens automatically so you can iterate through large datasets without implementing offset or cursor logic yourself. ### Can I write data back to Confluence On-Prem, or is the integration read-only? The Unified Knowledge Base API supports creating and updating pages in Confluence On-Prem, enabling write-back workflows like automated documentation generation. The exact supported operations depend on the resources configured for your integration — contact Truto for specifics on your use case. ### How do I ensure my integration respects Confluence's content permissions? Use the Unified User Directory API to fetch users and groups from the customer's Confluence instance. Map these identities to your application's user model so you can filter indexed content at query time, ensuring each end user only sees pages their Confluence permissions allow.