Get OpenAPI specification

Deploy API Endpoint Specification

Get content details changed since

Get source file details for a path

heretto-deploy-api/deploy-api-endpoint-specification/get-source-files

deploy-api-endpoint-specification/get-source-files

<body id="topic-8515"><main role="main"><article role="article" aria-labelledby="ariaid-title1"><h1 class="title topictitle1 hide-footer-title" id="ariaid-title1">Footer Section</h1><div class="body footer-container"><p class="shortdesc"></p><section class="section footer-item footer-links footer-full"><h2 class="title sectiontitle" id="our-support-team-is-here-to-help-0">Our Support Team is here to help</h2>
            
            <p class="p">Submit a support request or check the status of your existing requests. You can also email us.</p>
            <p class="p"><a class="xref footer-connect-button j-external-link" href="https://support.heretto.com/" target="_blank">Contact Support Team</a></p>
        </section><section class="section footer-bottom-container">

        <div class="div footer-item footer-links footer-bigger">
            <p class="p footer-img-left"><a class="xref j-external-link" href="https://heretto.com/" target="_blank"><img class="image footer-logo" src="https://heretto.deploy.heretto.com/v4/deployments/I9vA3KlK8201IYmECh5U/object/a69de2b0-741e-11ee-a3d9-0242d8e432a4?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJodHRwczovL2pvcnNlay5jb20vZXpkX29yZ2FuaXphdGlvbiI6ImpvcnNlay1kb2NzIiwiaHR0cHM6Ly9qb3JzZWsuY29tL2V6ZC9vYmplY3RfdXVpZCI6ImE2OWRlMmIwLTc0MWUtMTFlZS1hM2Q5LTAyNDJkOGU0MzJhNCIsImV4cCI6MTc2ODM1ODMxNiwianRpIjoiN2NjZjNkMmNiN2U5NDIxYjliYzgyMWMyMTNkYWNlZmMiLCJodHRwczovL2pvcnNlay5jb20vZXpkX2ZpbGVzZXQiOiJrWDduV2F0VGhGVkZ1dWpJU1ZUdCJ9.Ci7mGBaNnwv4ZnhdiButjx47Jm3SBbVxDT8UdhijK5U"></a></p>
            <p class="p footer-section-title">Love this help site?</p>
            <p class="p">You can have one, too! Using the Heretto CCMS as a foundation, our team can build a tailored portal that will delight your customers. Meet with our team to learn more.</p>
            <p class="p"><a class="xref footer-connect-button j-external-link" href="https://www.heretto.com/request-demo?utm_medium=direct-traffic&amp;utm_source=direct-traffic&amp;utm_campaign=demo-request&amp;utm_content=helpsite&amp;utm_term=" target="_blank">Connect with us</a></p>
        </div>
        <div class="div footer-item footer-links">
            <p class="p footer-heading">Explore</p>
            <p class="p"></p>
            <p class="p"></p>
            <p class="p"><a class="xref" href="/heretto-ccms/integrations/heretto-ccms-integrations-overview">Integrations</a></p>
            <p class="p"><a class="xref j-external-link" href="https://heretto.com/video-tutorials/" target="_blank">Video Tutorials</a></p>
            <p class="p"><a class="xref j-external-link" href="https://learningdita.com/" target="_blank">Learning DITA </a></p>
        </div>
        <div class="div footer-item footer-links">
            <p class="p footer-heading">Company</p>
            <p class="p"><a class="xref j-external-link" href="https://heretto.com/about-heretto/" target="_blank">About Us</a></p>
            <p class="p"><a class="xref j-external-link" href="https://www.heretto.com/contact" target="_blank">Contact Us</a></p>
            <p class="p"><a class="xref j-external-link" href="https://heretto.com/" target="_blank">heretto.com</a></p>
        </div>
        <div class="div footer-item footer-links">
            <p class="p footer-heading">Legalities</p>
            <p class="p"><a class="xref j-external-link" href="https://heretto.com/legal/" target="_blank">Legal</a></p>
            <p class="p"><a class="xref j-external-link" href="https://heretto.com/privacy-policy/" target="_blank">Privacy Policy</a></p>
            <p class="p"><a class="xref j-external-link" href="https://heretto.com/terms-of-use/" target="_blank">Terms of Use</a></p>
        </div>
        <div class="div footer-copyright-container">
            <div class="div copyright-left">
                <p class="p copyright-item">© 2026 Heretto Intellectual Property. All rights reserved.</p>
                <p class="p copyright-item"><a class="xref copyright-link j-external-link" href="https://heretto.com/legal/" target="_blank">Legal</a></p>
                <p class="p copyright-item"><a class="xref copyright-link j-external-link" href="https://heretto.com/privacy-policy/" target="_blank">Privacy Policy</a></p>
                <p class="p copyright-item"><a class="xref copyright-link j-external-link" href="https://heretto.com/terms-of-use/" target="_blank">Terms of Use</a></p>
                <p class="p copyright-item"><a class="xref copyright-link j-external-link" href="https://heretto.com/about-heretto/" target="_blank">About Us</a></p>
            </div>
            <div class="div copyright-right">
                <p class="p copyright-item"><a class="xref j-external-link" href="https://x.com/helloHeretto" target="_blank"><img class="image social-logo" src="https://heretto.deploy.heretto.com/v4/deployments/I9vA3KlK8201IYmECh5U/object/a6b402c0-741e-11ee-a3d9-0242d8e432a4?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJodHRwczovL2pvcnNlay5jb20vZXpkX29yZ2FuaXphdGlvbiI6ImpvcnNlay1kb2NzIiwiaHR0cHM6Ly9qb3JzZWsuY29tL2V6ZC9vYmplY3RfdXVpZCI6ImE2YjQwMmMwLTc0MWUtMTFlZS1hM2Q5LTAyNDJkOGU0MzJhNCIsImV4cCI6MTc2ODM1ODMxNiwianRpIjoiZjRmODVjZDY0NDQxNDJmNzk2NDU1NTY3ZTAyMjQ5YzYiLCJodHRwczovL2pvcnNlay5jb20vZXpkX2ZpbGVzZXQiOiJrWDduV2F0VGhGVkZ1dWpJU1ZUdCJ9.Wkr0_cZ8oMKggRJiaKj6Yt-MtFhkxQxAfG73TGZ7dY0"></a></p>
                <p class="p copyright-item"><a class="xref j-external-link" href="https://www.linkedin.com/company/heretto/" target="_blank"><img class="image social-logo" src="https://heretto.deploy.heretto.com/v4/deployments/I9vA3KlK8201IYmECh5U/object/a6c7b1d0-741e-11ee-a3d9-0242d8e432a4?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJodHRwczovL2pvcnNlay5jb20vZXpkX29yZ2FuaXphdGlvbiI6ImpvcnNlay1kb2NzIiwiaHR0cHM6Ly9qb3JzZWsuY29tL2V6ZC9vYmplY3RfdXVpZCI6ImE2YzdiMWQwLTc0MWUtMTFlZS1hM2Q5LTAyNDJkOGU0MzJhNCIsImV4cCI6MTc2ODM1ODMxNiwianRpIjoiMjA4ZDdjM2E2NzE0NDkxMmFkODdiNTA5MzYxNjJjMDYiLCJodHRwczovL2pvcnNlay5jb20vZXpkX2ZpbGVzZXQiOiJrWDduV2F0VGhGVkZ1dWpJU1ZUdCJ9.XBJ0_f07dcW8oTa_BPxIGYSdtCcx01PZdXiei3N7aOw"></a></p>
            </div>
        </div>

</section></div></article></main></body>

Footer Section

<i18n-message>[MISSING CONTENT]</i18n-message>

Etto, the Heretto Copilot, is a generative Artificial Intelligence (AI) tool built for Heretto CCMS. The goal of Etto is to help you create quality structured content in the DITA XML standard, boost productivity by assisting with time-consuming tasks, and improve overall content consistency.

Etto, the Heretto Copilot Overview

Deploy API Functions

Deploy API Content Flow

Deploy API Definitions

<body class="page-break-after" id="concept-925"><main role="main"><article role="article" aria-labelledby="ariaid-title1"><h1 class="title topictitle1" id="ariaid-title1"><span class="ph">Deploy API</span> Overview</h1><div class="body conbody"><div class="abstract">
        <div class="note note note_note"><span class="note__title">Note:</span> If you are looking for information about how to publish API specifications to <span class="ph">Heretto Portal</span>, see <a class="xref" href="/heretto-portal/heretto-portal-api-docs#concept-603">Heretto Portal API Docs</a>.</div>
        
        <p class="shortdesc"><span class="ph">Heretto Deploy API</span> is the crucial content delivery service that processes content from <span class="ph">Heretto CCMS</span> and transforms it into formats that can be delivered to end-users. The processed content is then delivered through the <span class="ph">Heretto Portal</span> or other delivery endpoints such as websites, applications, devices, or machines.</p>
    </div><p class="p">As an example, the documentation you are currently reading was delivered to this help site with <span class="ph">Deploy API</span>. Our help site is powered by both <span class="ph">Deploy API</span> and <span class="ph">Heretto Portal</span>.</p><div class="p"><span class="ph">Deploy API</span> supports: <ul class="ul"><li class="li">
                    <p class="p">Delivering localized content</p>
                </li><li class="li">
                    <p class="p">Managing access through authentication</p>
                </li><li class="li">
                    <p class="p">Tailoring content to different audiences (personalization)</p>
                </li></ul></div><p class="p">Key <span class="ph">Deploy API</span> use cases:</p><dl class="dl"><dt class="dt dlterm">Building Websites</dt><dd class="dd">
                    <p class="p">Transform your <span class="ph">Heretto CCMS</span> content into complete websites such as knowledge bases, support portals, or documentation hubs. Customize branding and design elements to maintain visual consistency with your existing web properties.</p>
                </dd><dt class="dt dlterm">Embedding Content</dt><dd class="dd">
                    <p class="p">Integrate content from <span class="ph">Heretto CCMS</span> directly into existing websites or applications. This enables context-sensitive help, in-app documentation, or targeted information delivery within your digital products.</p>
                    
                </dd><dt class="dt dlterm">Distributing to Multiple Endpoints</dt><dd class="dd">
                    <p class="p">Deploy your DITA source content to diverse delivery channels including IoT devices, embedded systems, and custom applications using <span class="ph">Deploy API</span>. This ensures consistent information across all customer touchpoints.</p>
                </dd></dl><p class="p">This single-source publishing approach ensures content consistency while reducing maintenance overhead. When you update content in <span class="ph">Heretto CCMS</span>, you can easily deliver it to all channels, typically significantly reducing publishing time compared to traditional multi-channel publishing workflows.</p></div><article class="topic concept nested1" aria-labelledby="ariaid-title2" lang="en-us" id="concept-5440"><h2 class="title topictitle2" id="ariaid-title2"><span class="ph">Deploy API</span> Functions</h2><div class="body conbody"><p class="shortdesc"><span class="ph">Heretto Deploy API</span> serves two main functions: it processes content managed in <span class="ph">Heretto CCMS</span>, and serves it to the <span class="ph">Heretto Portal</span> or other delivery endpoints such as websites, applications, devices, or machines.</p><dl class="dl"><dt class="dt dlterm">Content Processing</dt><dd class="dd">
                    <p class="p">The <span class="ph">Deploy API</span> processes content managed in <span class="ph">Heretto CCMS</span> and published through a deployment. It captures and snapshots all content involved in a publishing job, performs content rendering, and creates an immutable database of the final content.</p>
                </dd><dt class="dt dlterm">Content Delivery</dt><dd class="dd">
                    <p class="p">The <span class="ph">Deploy API</span> serves the processed content to delivery endpoints such as the <span class="ph">Heretto Portal</span>, websites, applications, machines, and devices. </p>
                </dd></dl><div class="note note note_note"><span class="note__title">Note:</span> 
            <p class="p">In <span class="ph">Deploy API</span>, the functions of processing and serving content are separated to make it resilient and scalable. This change is currently only applicable to manual deployments. <span class="ph">Deploy API</span> conceptually runs in the same infrastructure as Cloud Publishing, with each deployment being treated as a publishing job and processed in an ephemeral container in the cloud.</p>
            
        </div></div></article><article class="topic concept nested1" aria-labelledby="ariaid-title3" lang="en-us" id="concept-875"><h2 class="title topictitle2" id="ariaid-title3"><span class="ph">Deploy API</span> Content Flow</h2><div class="body conbody"><p class="shortdesc"><span class="ph">Heretto Deploy API</span> serves as the processing and delivery engine for <span class="ph">Heretto CCMS</span> content. It transforms content into delivery-ready formats and distributes it to various endpoints including websites, applications, and devices.</p><section class="section"><h3 class="title sectiontitle" id="how-content-is-passed-to-deploy-api-0">How Content is Passed to <span class="ph">Deploy API</span></h3>
            
            <p class="p">Once content is finalized in <span class="ph">Heretto CCMS</span>, it moves to the <span class="ph">Deploy API</span> through  deployments. </p>
            <p class="p">Deployments are essential configuration elements that determine which content is published, where it's published, and under what conditions. Deployments connect specific content in the CCMS with appropriate delivery endpoints such as <span class="ph">Heretto Portal</span> or other delivery endpoints.</p>
            <p class="p"><span class="ph">Deploy API</span> supports two deployment types:</p>
            <dl class="dl"><dt class="dt dlterm"><span class="ph b">Active Sync</span></dt><dd class="dd">
                        <p class="p">Automatically and continually publishes content updates from the CCMS to delivery endpoints. As content creators make changes in the CCMS, their updates are rapidly integrated into the associated deployment and published to a delivery endpoint. </p>
                        <p class="p">Active sync is valuable for preview environments where teams need to see work-in-progress content. Due to its immediate nature and the risk of publishing work-in-progress content, active sync is not available for production portal environments.</p>
                    </dd><dt class="dt dlterm"><span class="ph b">Manual Deploy</span></dt><dd class="dd">
                        <p class="p">Requires deliberate user action to initiate the publishing process. Content updates remain in the CCMS until a user manually publishes a deployment. This deployment type gives teams control over when updates are released, enabling them to work on substantial content updates.</p>
                        <p class="p">Manual deploy is available for all portal environments. It is the standard configuration for publishing official content versions.</p>
                    </dd></dl>
        </section><section class="section"><h3 class="title sectiontitle" id="how-content-becomes-a-deployment-0">How Content Becomes a Deployment</h3>
            
            <p class="p">Once content is passed from <span class="ph">Heretto CCMS</span> through a deployment to <span class="ph">Deploy API</span>, it is processed into a final output and served to the <span class="ph">Heretto Portal</span> or other delivery endpoints.</p>
            <p class="p">Processing a deployment involves evaluating raw DITA content and associated assets and converting them into a final output used to serve the content to its final delivery endpoint for end-user consumption. All deployment processing starts in <span class="ph">Heretto CCMS</span> with the deployment configuration and a DITA map (sitemap). At a high level, the following happens during a deployment processing:</p>
            <ul class="ul"><li class="li">
                    <p class="p">Deployment instructions indicate the audiences and the locales (target languages) that are included.</p>
                </li><li class="li">
                    <p class="p">The map defines the scope of the deployment.</p>
                </li><li class="li">
                    <p class="p">All content files for a tenant are located and made available.</p>
                </li><li class="li">
                    <p class="p">All source content is processed into a normalized structure with all necessary information for output. </p>
                    <p class="p">This process involves steps such as: evaluating document metadata, including or excluding review markup, processing conditional sets, processing keyrefs and xrefs, link correction, and processing tables and figures.</p>
                </li></ul>
            <p class="p">At this point, there is an ephemeral in-memory representation of the full set of content in an intermediate state that is <em class="ph i">nearly</em> final. The content is ready to be rapidly transformed into a final output format, like HTML. This process of building a content set in its <em class="ph i">nearly</em> final state is used by both active sync and manual deploy deployments. How the two deployment types use this process varies, as described below.</p>
            <dl class="dl"><dt class="dt dlterm">Active Sync Processing</dt><dd class="dd">
                        <p class="p">With an active sync deployment, the process is always on, hosting the content in its <em class="ph i">nearly</em> final state. The content in this case is hosted within <span class="ph">Deploy API</span>. </p>
                        <p class="p">There are two reasons it works this way. The content can be quickly returned in the final format to serve content requests. Additionally, the intermediate in-memory state is ideal for quickly integrating content changes from the CCMS.</p>
                        <p class="p">The primary benefit of this structure is the rapid integration of new content. That benefit comes with some expense:</p>
                        <ul class="ul"><li class="li">
                                <p class="p">The representation is ephemeral and must be reprocessed at restart</p>
                            </li><li class="li">
                                <p class="p">All content must fit in memory</p>
                            </li><li class="li">
                                <p class="p">An error in content can impact the APIs ability to respond to content requests</p>
                            </li><li class="li">
                                <p class="p">Auto scaling the API is slow because of the initial processing duration</p>
                            </li></ul>
                    </dd><dt class="dt dlterm">Manual Deploy Processing</dt><dd class="dd">
                        <p class="p">With a manual deployment, the process of building the set of content in its <em class="ph i">nearly</em> final state happens outside of <span class="ph">Deploy API</span>. When deployment publishing is triggered, a publishing job is initiated that performs the processing. At the end of processing the content, a snapshot is generated. The snapshot includes: all the files used for processing, an immutable database with all content in its final form, and search indexes. Upon completion of processing and storage, the <span class="ph">Deploy API</span> switches to serving content from the new immutable database.</p>
                        <p class="p">There are multiple benefits to this mode of operation:</p>
                        <ul class="ul"><li class="li">
                                <p class="p">All content processing happens outside of the production API, reducing the risk that a content error makes the API unavailable</p>
                            </li><li class="li">
                                <p class="p">Rapid auto scaling because all content is pre-processed</p>
                            </li><li class="li">
                                <p class="p">The code base for serving content is 90% smaller, leaving less surface area for issues</p>
                            </li><li class="li">
                                <p class="p">Highly efficient memory and content serving for a great experience</p>
                            </li><li class="li">
                                <p class="p">Content no longer needs to fit directly into memory, greatly increasing safety</p>
                            </li></ul>
                        <p class="p">The main tradeoff of manual deployments is that content updates take longer to become available, as the processing job must finish before new content is deployed.</p>
                    </dd></dl>
        </section></div></article><article class="topic concept nested1" aria-labelledby="ariaid-title4" lang="en-us" id="concept-4005"><h2 class="title topictitle2" id="ariaid-title4"><span class="ph">Deploy API</span> Definitions</h2><div class="body conbody"><p class="shortdesc"></p><dl class="dl"><dt class="dt dlterm">Delivery Endpoint</dt><dd class="dd"><p class="p">A delivery endpoint is any final destination where users consume content that has been processed by <span class="ph">Heretto Deploy API</span>. Delivery endpoints can include <span class="ph">Heretto Portal</span>, websites, applications, devices, and machines.</p><p class="p">Delivery  endpoints receive content that is managed in <span class="ph">Heretto CCMS</span>, processed by <span class="ph">Deploy API</span>, and transformed into appropriate formats for end-user consumption.</p></dd><dt class="dt dlterm">Deployments</dt><dd class="dd"><p class="p">Deployments are configurations that connect content in the CCMS with delivery endpoints via <span class="ph">Deploy API</span>. They enable content publication to the appropriate delivery endpoint, like  <span class="ph">Heretto Portal</span> or other delivery endpoints such as websites, applications, devices, or machines.</p></dd><dt class="dt dlterm"><span class="ph">Heretto Deploy API</span></dt><dd class="dd">
                    <p class="p">A read-only API that enables you to deliver content from <span class="ph">Heretto CCMS</span> to different endpoints. The delivered content includes:</p>
                    <ul class="ul" id="concept-4005__ul_p1y_3lf_sjb"><li class="li">JSON data</li><li class="li">Media files</li><li class="li">Transformed XML content (HTML5) or compiled DITA</li></ul>
                </dd><dt class="dt dlterm">Serving Content</dt><dd class="dd"><p class="p">The process of requesting and receiving a final result from <span class="ph">Deploy API</span>, which may be content on a page or the structure required to serve that content. For example, when users access a page, they're essentially making an API request to <span class="ph">Deploy API</span>, which then delivers the requested content. This technical interaction forms the foundation of content delivery within the system.</p></dd><dt class="dt dlterm">Sitemaps</dt><dd class="dd">
                    <p class="p">Sitemaps are specialized DITA maps that determine the structure of your content. Depending on the environment you publish to, you may need to use different <span class="ph">sitemap</span> structures.</p>
                    <p class="p"><span class="ph">Deploy API</span> supports different <span class="ph">sitemap</span> structures.</p>
                </dd></dl></div></article></article></main></body>

Heretto Deploy API ensures secure processing and delivery of your content for end-user consumption. Deploy API employs two API authentication methods to securely distribute content from Heretto CCMS to various delivery endpoints: Simple API Keys and JSON Web Tokens (JWTs). Both methods are managed as API keys within Heretto CCMS. API keys are also known as secret keys or secrets.

Deploy API Authentication

Read the Deploy API specification and related resources

Heretto Deploy API

Heretto Deploy API is the crucial content delivery service that processes content from Heretto CCMS and transforms it into formats that can be delivered to end-users. The processed content is then delivered through the Heretto Portal or other delivery endpoints such as websites, applications, devices, or machines.

Deploy API Overview

Use Heretto API Docs to publish API documentation for public and internal consumption within Heretto Portal.

API Docs Overview

<body id="topic-9225"><main role="main"><article role="article" aria-labelledby="ariaid-title1"><h1 class="title topictitle1" id="ariaid-title1">Heretto Deploy Portal Overview</h1><div class="body"><p class="shortdesc"></p><iframe class="object iframe" controls="controls" src="https://www.youtube.com/embed/45CFJ3YhByI?list=PL4ZeW5ujwMiG-qroejPZ7DDYRf-potbdf" referrerpolicy="strict-origin-when-cross-origin" allowtransparency="true" frameborder="0" scrolling="no" allowfullscreen="true" mozallowfullscreen="true" webkitallowfullscreen="true" oallowfullscreen="true" msallowfullscreen="true" width="100%" height="270"></iframe><section class="section"><h2 class="title sectiontitle" id="heretto-deploy-portal-overview-0">Heretto Deploy Portal Overview</h2>
            
            <p class="p">Real-time content delivery anywhere</p>
        </section></div></article></main></body>

Heretto Deploy Portal Overview

<body id="topic-2626"><main role="main"><article role="article" aria-labelledby="ariaid-title1"><h1 class="title topictitle1" id="ariaid-title1">Heretto UX Overview</h1><div class="body"><p class="shortdesc"></p><iframe class="object iframe" controls="controls" src="https://www.youtube.com/embed/qJNtVI2cKTA" referrerpolicy="strict-origin-when-cross-origin" allowtransparency="true" frameborder="0" scrolling="no" allowfullscreen="true" mozallowfullscreen="true" webkitallowfullscreen="true" oallowfullscreen="true" msallowfullscreen="true" width="100%" height="270"></iframe><section class="section"><h2 class="title sectiontitle" id="heretto-ux-overview-0">Heretto UX Overview</h2>
            
            <p class="p"><a class="xref external-video-link j-external-link" href="https://heretto.com/product-pulse/" target="_blank">View more videos</a></p>
        </section></div></article></main></body>

Heretto UX Overview

A new CCMS version with a fix to the Localization module and a lot of behind-the-scenes progress on the  next-generation Linking and Releases modules. 🙌

January 10, 2026

<body id="concept-8026"><main role="main"><article role="article" aria-labelledby="ariaid-title1"><h1 class="title topictitle1" id="ariaid-title1">CCMS API Overview</h1><div class="body conbody"><div class="abstract"><div class="note note note_note"><span class="note__title">Note:</span> 
            <p class="p">This is an Alpha release of the CCMS API v2 that can be used alongside CCMS API v1. This  release is part of the CCMS API v2 effort  that aims at providing a complete set of CCMS APIs and currently focuses on publishing with  deployments as well as <span class="ph">PDF Generator</span> and <span class="ph">DITA Open Toolkit (DITA-OT)</span>. The API is now available to all <span class="ph">Heretto</span> customers. No upgrades or configurations are required. </p><p class="p">To access CCMS API v1 documentation, contact your <span class="ph">Customer Success Manager</span>.</p>
        </div><p class="shortdesc">The <span class="ph">Heretto CCMS</span> API (v2) enables programmatic access to publishing and deployment operations within the <span class="ph">Heretto</span> Component Content Management System (CCMS). This REST API enables you to automate publishing workflows, manage deployments, retrieve publishing outputs, and configure publishing scenarios.</p></div><p class="p">The <span class="ph">Heretto CCMS</span> API is designed to support various automation and integration scenarios:</p><dl class="dl"><dt class="dt dlterm">CI/CD pipeline integration</dt><dd class="dd">Automate content publishing as part of your continuous integration and deployment workflows.</dd><dt class="dt dlterm">Custom publishing dashboards</dt><dd class="dd">Build internal tools to monitor publishing operations and deployment status.</dd><dt class="dt dlterm">Scheduled publishing</dt><dd class="dd">Trigger publishing jobs automatically based on schedules or external events.</dd><dt class="dt dlterm">Multi-locale management</dt><dd class="dd">Programmatically manage content deployments across multiple languages and regions.</dd><dt class="dt dlterm">Audit and compliance</dt><dd class="dd">Track and report on publishing history for regulatory requirements.</dd></dl><p class="p">This API enables you to work with these CCMS interfaces:</p><dl class="dl"><dt class="dt dlterm">Deployments</dt><dd class="dd">Work with preconfigured deployments in the CCMS to manage content publishing from the CCMS to <span class="ph">Heretto Portal</span> or other delivery endpoints such as websites, applications, devices, or machines.</dd><dt class="dt dlterm">Publishing jobs</dt><dd class="dd">Manage CCMS content publishing to static outputs, like PDF or HTML, by using publishing engines like <span class="ph">PDF Generator</span> or <span class="ph">DITA Open Toolkit (DITA-OT)</span>.</dd><dt class="dt dlterm">Publishing scenarios</dt><dd class="dd">Retrieve available scenarios and their configurable parameters, which you can then use when creating publishing jobs.</dd><dt class="dt dlterm">Releases</dt><dd class="dd">Retrieve information about existing releases (snapshots of content).</dd></dl><section class="section"><h2 class="title sectiontitle" id="authentication-0">Authentication</h2>
            
            <p class="p">The <span class="ph">Heretto CCMS</span> API supports two authentication methods:</p>
            <dl class="dl"><dt class="dt dlterm">Basic Authentication</dt><dd class="dd">
                        <p class="p">Include an <code class="ph codeph">Authorization</code> header with the value <code class="ph codeph">Basic &lt;base64(username:password)&gt;</code> in your API requests. You can use your CCMS username and either your password or an API token generated in the CCMS.</p>
                    </dd><dt class="dt dlterm">SSO Cookie Authentication </dt><dd class="dd">
                        <p class="p">Include the <code class="ph codeph">JSESSIONID</code> cookie from your authenticated browser session. This method is useful when testing the API from this documentation site or integrating with browser-based tools that maintain SSO sessions.</p>
                    </dd></dl>
            <p class="p">For more information, see <a class="xref" href="/heretto-ccms/api/ccms-api-authentication">CCMS API Authentication</a>.</p>
        </section><section class="section" id="concept-8026__base-url"><h2 class="title sectiontitle" id="base-url-0">Base URL</h2>
            
            <p class="p">All API requests use this base URL structure:</p>
            <pre class="pre codeblock lang-http"><code>https://{organizationId}.heretto.com/ezdnxtgen/api</code></pre>
            <p class="p" id="concept-8026__where-organizationId-is">Where <code class="ph codeph">{organizationId}</code> is the subdomain you use to access <span class="ph">Heretto CCMS</span>. For example, if you access <span class="ph">Heretto CCMS</span> at <code class="ph codeph">https://thunderbird.heretto.com</code>, use <code class="ph codeph">thunderbird</code> as the <code class="ph codeph">organizationId</code>.</p>
        </section><section class="section"><h2 class="title sectiontitle" id="important-considerations-0">Important Considerations</h2>
            
            <ul class="ul"><li class="li">
                    <p class="p">The <span class="ph">Heretto CCMS</span> API doesn't support bulk updates. You can work on only one object per request.</p>
                </li><li class="li">
                    <p class="p">The API supports pagination for endpoints that return large result sets, such as publishing history and scenario listings. Use the <span class="keyword parmname">page</span>(zero-indexed) and <span class="keyword parmname">size</span>(default: 20, maximum: 100) query parameters to navigate through results. Responses include metadata such as <code class="ph codeph">totalPages</code>, <code class="ph codeph">totalElements</code>, and<code class="ph codeph">numberOfElements</code>to help you implement pagination controls.</p>
                </li></ul>
        </section></div></article></main></body>

The CCMS API supports Basic Authentication and SSO Cookie Authentication for secure access.

CCMS API Authentication

The Heretto CCMS API (v2) enables programmatic access to publishing and deployment operations within the Heretto Component Content Management System (CCMS). This REST API enables you to automate publishing workflows, manage deployments, retrieve publishing outputs, and configure publishing scenarios.

CCMS API Overview

Configure Web Crawler Settings

<body id="concept-2558"><main role="main"><article role="article" aria-labelledby="ariaid-title1"><h1 class="title topictitle1" id="ariaid-title1"><span class="ph">Heretto Portal</span> Web Crawlers Configuration</h1><div class="body conbody"><div class="abstract">
         <span class="shortdesc">Web crawlers (also called bots) are automated programs that systematically browse and scan the internet to collect information about websites. They are primarily used by search engines to discover and index web pages as well as by Artificial Intelligence (AI) bots to collect bulk training data from your site.</span>
    </div><p class="p">When a bot visits your <span class="ph">Heretto Portal</span>, it goes through this sequence:</p><ol class="ol"><li class="li">
                <p class="p">Access check: The portal checks if the bot's user-agent passes the browser version requirements or is on the whitelist </p>
            </li><li class="li">
                <p class="p">Crawl rules: If access is granted, the bot reads the <span class="ph filepath">robots.txt</span> file to learn what it can crawl</p>
            </li><li class="li">
                <p class="p"> Page-level rules: As the bot accesses individual pages, it reads meta tags for page-specific instructions</p>
            </li></ol><p class="p"><span class="ph">Heretto Portal</span> gives you full control over how bots interact with  content on your production portal environment through three configuration options:</p><ul class="ul"><li class="li">
                <p class="p"><code class="ph codeph">userAgentWhitelist</code>: Controls which bots can bypass browser version checks and access your production portal </p>
            </li><li class="li">
                <p class="p"><code class="ph codeph">robotsTxt</code>: Controls which areas of your site bots can crawl </p>
            </li><li class="li">
                <p class="p"><code class="ph codeph">robotsMeta</code>: Controls how individual pages are indexed</p>
            </li></ul><p class="p">You can configure these settings for your production portal  environment through the main <span class="ph filepath">config.json</span> file associated with your main portal sitemap. This configuration is exclusive to production environments, as non-production portal environments are private and not indexed.</p><div class="note important note_important"><span class="note__title">Important:</span> <p class="p" id="concept-2558__p-consult-implementation-team-before-making-changes">If your production portal is not officially launched yet, consult the <span class="ph">Heretto</span> Implementation Team before making any changes to crawler settings. During the implementation phase, SEO is disabled for production portal environments.</p></div><p class="p">Let's take a closer look at these settings:</p><dl class="dl"><dt class="dt dlterm"><code class="ph codeph">userAgentWhitelist</code> setting</dt><dd class="dd">
                    <p class="p">The <code class="ph codeph">userAgentWhitelist</code> parameter enables you to control  which bots can access your production portal. By default, the whitelist is empty and all bots are blocked, which protects your content from being accessed by any bot without your explicit permission. </p>
                    
                    
                    <p class="p">The whitelist uses partial string matching against the user-agent header, for example,  <code class="ph codeph">claude</code> matches <code class="ph codeph">claudeBot</code>. If a match is found, the bot gets access to your production portal.</p>
                    <div class="note note note_note"><span class="note__title">Note:</span> 
                        <p class="p">This setting only controls whether a bot can access your production portal. To control what content bots can crawl or index once they have access, configure <code class="ph codeph">robotsTxt</code> and <code class="ph codeph">robotsMeta</code> described below.</p>
                    </div>
                    <p class="p">An example that whitelists a few of the most popular AI bots:</p>
                    <pre class="pre codeblock language-json"><code>"userAgentWhitelist": ["claude", "gpt", "gemini", "microsoft", "copilot", "grok"]</code></pre>
                </dd><dt class="dt dlterm"><code class="ph codeph">robotsTxt</code> setting</dt><dd class="dd">
                    <p class="p">The <code class="ph codeph">robotsTxt</code> parameter enables you to overwrite the default <span class="ph filepath">robots.txt</span> file settings of a production portal environment.</p><p class="p">When a bot visits a website, it first looks for the <span class="ph filepath">robots.txt</span> file in the root directory, reads the rules in this file, and, unless it's malicious, follows the instructions.  For example, when a bot visits your production portal environment, it goes to <span class="ph filepath">https://<var class="keyword varname">your-portal-domain</var>/robots.txt</span>.  </p>
                    
                    <p class="p">By default, for production portal environments, the  <span class="ph filepath">robots.txt</span> file is set up such that it prevents all bots from accessing the backend API and  frontend assets like JavaScript or CSS files, and points them at the <span class="ph filepath">sitemap.xml</span> file for indexing. You can override these default settings by using the  <code class="ph codeph">robotsTxt</code> parameter. </p>
                    
                    
                    <p class="p">An example of a <code class="ph codeph">robotsTxt</code> parameter that blocks all bots from accessing everything on a portal:</p>
                    <pre class="pre codeblock language-json"><code>"robotsTxt": "User-agent: *\nDisallow: /\nSitemap: __domain__/sitemap.xml"</code></pre>
                    <p class="p">where, <code class="ph codeph">__domain__</code> represents your portal domain and gets replaced with it automatically.</p><div class="note important note_important"><span class="note__title">Important:</span> 
                        <p class="p">When setting up the <code class="ph codeph">robotsTxt</code> parameter, ensure it  includes unchanged parts, like the sitemap, as it completely replaces the <span class="ph filepath">robots.txt</span> file.</p>
                    </div>
                </dd><dt class="dt dlterm"><code class="ph codeph">robotsMeta</code> setting</dt><dd class="dd">
                    <p class="p">The <code class="ph codeph">robotsMeta</code> parameter enables you to control how search engines handle individual pages, for example, whether to index them, follow links, or show snippets in search results.</p>
                    <p class="p">Common settings include <code class="ph codeph">index</code> and <code class="ph codeph">noindex</code> to include and exclude pages from search results respectively, <code class="ph codeph">follow</code> and <code class="ph codeph">nofollow</code> to enable and prevent following links on a page, and <code class="ph codeph">snippet</code> and  <code class="ph codeph">nosnippet</code> to show and hide preview snippets.</p>
                    <p class="p">An example of the <code class="ph codeph">robotsMeta</code> parameter that tells search engines to index a portal and follow its links:</p>
                    <pre class="pre codeblock language-json"><code>"robotsMeta": "index, follow"</code></pre></dd></dl><section class="section"><h2 class="title sectiontitle" id="important-considerations-0">Important Considerations</h2><ul class="ul"><li class="li"><p class="p">This configuration is available only for production portal environments with SEO enabled. You can choose to enable SEO in your production portal environment or keep it disabled. </p></li><li class="li"><p class="p">If your production portal is not officially launched yet, consult the <span class="ph">Heretto</span> Implementation Team before making any changes to crawler settings. During the implementation phase, SEO is disabled for production portal environments.</p></li><li class="li"><p class="p">Non-production environments remain private, unindexed, and have SEO disabled.</p></li><li class="li"><p class="p">When SEO is enabled and <code class="ph codeph">robotsMeta</code> is empty, the default  setting is <code class="ph codeph">index, follow</code>. When <code class="ph codeph">robotsMeta</code> is defined, it overrides the defaults.</p></li><li class="li"><p class="p">When SEO is disabled, the default <code class="ph codeph">robotsMeta</code> setting is <code class="ph codeph">noindex, nofollow</code>. </p></li><li class="li"><p class="p">Malicious bots may ignore your instructions.</p></li></ul></section></div><article class="topic task nested1" aria-labelledby="ariaid-title2" id="task-6578"><h2 class="title topictitle2" id="ariaid-title2">Configure Web Crawler Settings</h2><div class="body taskbody"><div class="abstract">
        <p class="shortdesc">You can configure web crawler behavior for your production <span class="ph">Heretto Portal</span> environment to control which bots can access your site, what content they can crawl, and how pages are indexed. You add this configuration to the main <span class="ph filepath">config.json</span> file associated with your main portal sitemap. </p><p class="p">This configuration is available only for production portal environments with SEO enabled. Non-production environments remain private, unindexed, and have SEO disabled.</p>
        
        
    <div class="note important note_important"><span class="note__title">Important:</span> <p class="p" id="task-6578__p-consult-implementation-team-before-making-changes">If your production portal is not officially launched yet, consult the <span class="ph">Heretto</span> Implementation Team before making any changes to crawler settings. During the implementation phase, SEO is disabled for production portal environments.</p></div></div><div class="section prereq p"><ul class="ul"><li class="li"><p class="p">Ensure you have the permissions to edit the main <span class="ph filepath">config.json</span> file associated with your main portal sitemap.</p></li><li class="li"><p class="p">View the default <span class="ph filepath">robots.txt</span> settings for your production portal environment at <code class="ph codeph">https://<var class="keyword varname">your-portal-domain</var>/robots.txt</code>. </p></li></ul>
            
        </div><div class="li stepsection">
                <p class="p">Configure the <code class="ph codeph">userAgentWhitelist</code> parameter</p>
            </div><ol class="ol steps"><li class="li step stepexpand"><span class="ph cmd">In the <span class="ph">master branch</span>, navigate to the main <span class="ph filepath">config.json</span> file associated with your main portal sitemap.</span></li><li class="li step stepexpand"><span class="ph cmd">Right-click the <span class="ph filepath">config.json</span> file and select <span class="ph"><span class="ph uicontrol">Edit Source</span></span>. </span></li><li class="li step stepexpand"><span class="ph cmd">In the <span class="ph">Source Editor</span>, scroll to the bottom of the file and add the <code class="ph codeph">userAgentWhitelist</code> element with the bots you want to whitelist:</span><div class="itemgroup stepxmp">
<p class="p">This setting whitelists some of the main AI bots: </p>                    <pre class="pre codeblock language-json"><code>"userAgentWhitelist": ["claude", "gpt", "gemini", "microsoft", "copilot", "grok"],</code></pre>
                </div></li></ol><div class="li stepsection">
                <p class="p">Configure <code class="ph codeph">robotsTxt</code> and <code class="ph codeph">robotsMeta</code> parameters</p>
            </div><ol class="ol steps" start="4"><li class="li step stepexpand"><span class="ph cmd">In the <span class="ph">Source Editor</span>, scroll to the bottom of the <span class="ph filepath">config.json</span> file and, if not present, add the <code class="ph codeph">seo</code> section like shown here. </span><div class="itemgroup info">
                    <pre class="pre codeblock language-json"><code>"seo": {
        "robotsTxt": "", 
        "robotsMeta": ""
    }</code></pre>
                    <p class="p">where</p>
                    <ul class="ul"><li class="li">
                            <p class="p">The <code class="ph codeph">robotsTxt</code> parameter defines the rules for the <span class="ph filepath">robots.txt</span> file, which search engine crawlers use to determine what parts of the site they can and cannot access</p>
                        </li><li class="li">
                            <p class="p">The <code class="ph codeph">robotsMeta</code> parameter defines meta directives for search engines, typically embedded in the <code class="ph codeph">meta</code> tag of the HTML header</p>
                        </li></ul>
                </div></li><li class="li step stepexpand"><span class="ph cmd">Add desired values to the <code class="ph codeph">robotsTxt</code> parameter.</span><div class="itemgroup info">
                    <p class="p">Here are some important guidelines for configuring crawler settings:</p>
                    <ul class="ul"><li class="li">
                            <p class="p">In the <code class="ph codeph">robotsTxt</code> parameter, separate each value, like <code class="ph codeph">User-agent: *</code> or <code class="ph codeph">Disallow: /api/*</code>, with <code class="ph codeph">\n</code> to indicate to the <span class="ph filepath">robots.txt</span> file where a new line starts.</p>
                        </li><li class="li">
                            <p class="p">Separate multiple entries in the <code class="ph codeph">seo</code> parameter with commas (<code class="ph codeph">,</code>). For example, <code class="ph codeph">"robotsTxt": "User-agent: *\nDisallow:\nSitemap: __domain__/sitemap.xml",</code></p><div class="note note note_note"><span class="note__title">Note:</span> <p class="p">The  <code class="ph codeph">__domain__</code> variable represents your portal domain and gets replaced with it automatically.</p></div>
                        </li></ul>
                    
                </div><div class="itemgroup stepxmp">
                    <pre class="pre codeblock language-json"><code>"seo": { 
        "robotsTxt": "User-agent: *\nDisallow:\nSitemap: __domain__/sitemap.xml",
	    "robotsMeta": ""	
    }</code></pre>
                    <p class="p">With <code class="ph codeph">\n</code> added as in this example, the <span class="ph filepath">robots.txt</span> file will be interpreted and rendered like this:</p>
                    <pre class="pre codeblock lang-txt"><code>User-agent: *
Disallow: 
Sitemap: __domain__/sitemap.xml
</code></pre>
                </div></li><li class="li step stepexpand"><span class="ph cmd">Add desired values to the <code class="ph codeph">robotsMeta</code> parameter.</span><div class="itemgroup info">
                    <p class="p">Note that you need a comma after the <code class="ph codeph">robotsTxt</code> entry and no comma after <code class="ph codeph">"robotsMeta": "index, follow"</code>.</p>
                </div><div class="itemgroup stepxmp">
                    <pre class="pre codeblock language-json"><code>"seo": { 
        "robotsTxt": "User-agent: *\nDisallow:\nSitemap: __domain__/sitemap.xml", 
        "robotsMeta": "index, follow"
    }</code></pre>
                    <p class="p">With <code class="ph codeph">robotsMeta</code> set up like this, the <code class="ph codeph">meta</code> tag of the HTML header will be interpreted like this:</p>
                    <pre class="pre codeblock lang-html"><code>&lt;meta name="robots" content="index, follow"&gt;</code></pre>
                </div></li><li class="li step stepexpand"><span class="ph cmd">Save your changes.</span></li></ol><div class="li stepsection">
                <p class="p">Validate and publish</p>
            </div><ol class="ol steps" start="8"><li class="li step stepexpand"><span class="ph cmd">Validate your <span class="ph filepath">.json</span> file.</span><div class="itemgroup info"><p class="p">This syntax is very specific and won't validate if, for example, spaces are missing, or you have an extra comma. One option for validating the file is at <a class="xref j-external-link" href="https://jsonlint.com/" target="_blank">https://jsonlint.com/</a>.</p></div></li><li class="li step stepexpand"><span class="ph cmd">Push the <span class="ph filepath">config.json</span> file from the master branch to your production branch and publish the changes.</span></li></ol><section class="section result">
            <p class="p">You modified crawler settings for your production portal environment. The user-agent whitelist takes effect immediately for bot access. The new SEO settings are now available for the  <span class="ph filepath">robots.txt</span> file and meta HTML tag. Remember that malicious crawlers may ignore your instructions. For sensitive data, consider using authentication.</p>
        </section><div class="example">
            <p class="p">Complete configuration of all three parameters:</p>
            <pre class="pre codeblock language-json"><code>"userAgentWhitelist": ["claude", "gpt", "gemini", "microsoft", "copilot", "grok"],
"seo": {
    "robotsTxt": "User-agent: *\nDisallow:\nSitemap: __domain__/sitemap.xml", 
    "robotsMeta": "index, follow"
}</code></pre></div></div></article></article></main></body>

heretto-portal/heretto-portal-sso/portal-sso-overview

Heretto Portal SSO

heretto-portal/heretto-portal-seo/introduction-to-search-engine-optimization

Heretto Portal SEO

Search Engine Optimization (SEO)  is the process of optimizing a website or web content to improve its visibility in search engine results pages (SERPs). The goal of SEO is to drive more organic (unpaid) traffic to a website by ensuring it appears prominently for relevant search queries.

Introduction to Search Engine Optimization

Web crawlers (also called bots) are automated programs that systematically browse and scan the internet to collect information about websites. They are primarily used by search engines to discover and index web pages as well as by Artificial Intelligence (AI) bots to collect bulk training data from your site.

Heretto Portal Web Crawlers Configuration

Content Operations Platform For Knowledge Management | Heretto

Learn how to author, review, manage, translate, and publish to multiple channels

Heretto CCMS

Learn how to dynamically distribute your content to any audience, anytime

Heretto Portal

Learn what has changed in Heretto products

Release Notes

Here you can find a typical flow of API operations for a deployment process.

Deploy API Calls Flow

Defining audiences in a map or for a deployment enables your content to reach the recipients you intend for it. This way users receive the information that is relevant to them, and are restricted from accessing other content.

Under maintenance

Heretto Help

Footer Section

Our Support Team is here to help