Heretto API

openapi: 3.1.0
info:
  title: Heretto API
  version: '2026-10-20'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-20: 5 operation(s) read from 6 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; Heretto has published no machine-readable contract that the pipeline
    could find. Engine: local.'
  x-evidence-tiers:
    code-example: 4
    documentation: 1
    pages-with-code: 5
    pages-read: 6
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-20'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://help.heretto.com/en/heretto-deploy-api/deploy-api-authentication
  - https://help.heretto.com/en/heretto-ccms/api/ccms-api-authentication
  - https://help.heretto.com/en/heretto-ccms/api/ccms-api-authentication/basic-authentication
  - https://help.heretto.com/en/heretto-ccms/api/ccms-api-authentication/sso-cookie-authentication
  - https://help.heretto.com/en/heretto-ccms/integrations/authoring-integrations/authoring-in-oxygen/heretto-ccms-and-oxygen-configuration-process/connect-heretto-ccms-and-oxygen-through-webdav
  - https://help.heretto.com/en/heretto-ccms/publish/pdf-generator/configure-and-manage-pdf-generator-publishing-scenarios
servers:
- url: https://thunderbird.deploy.heretto.com
paths:
  /cms/v1/all-files/6ebe20b0-55ce-11eb-a796-02428d90e38c/download-as-bundle-for-pdfgen:
    post:
      operationId: post_cms_v1_all_files_6ebe20b0_55ce_11eb_a796_02428d90e38c_download_as_bundle_fo
      tags:
      - Cms
      summary: Error - Failed - unable to process
      description: The page shows this endpoint in an error message when publishing a document with a duplicated scenario.
      x-source: https://help.heretto.com/en/heretto-ccms/publish/pdf-generator/configure-and-manage-pdf-generator-publishing-scenarios
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /ezdnxtgen/api/v2/deployments:
    get:
      operationId: get_ezdnxtgen_api_v2_deployments
      tags:
      - Ezdnxtgen
      summary: GET /ezdnxtgen/api/v2/deployments
      x-source: https://help.heretto.com/en/heretto-ccms/api/ccms-api-authentication
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X GET  'https://thunderbird.heretto.com/ezdnxtgen/api/v2/deployments'  -H 'Authorization: Basic ZGVtbzpocnRfYWJjMTIzWFlaNDU2'\
          \ \n Basic authentication is represented by the basicAuth parameter in the API endpoint specification. \n SSO Cookie Authentication\
          \ \n Use your browser session cookie from an active Heretto CCMS login for authentication. \n Cookie: JSESSIONID=<your-session-id> \n\
          \ Example: "
  /tools/token-management/tokens.xql:
    get:
      operationId: get_tools_token_management_tokens_xql
      tags:
      - Tools
      summary: GET /tools/token-management/tokens.xql
      x-source: https://help.heretto.com/en/heretto-ccms/api/ccms-api-authentication/basic-authentication
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: curl, Postman, or custom scripts. You can also use this token to authenticate a WebDAV connection with Oxygen XML Editor or Oxygen
          XML Author. If single sign-on (SSO) is configured in the CCMS, you must generate a token to authenticate API requests. If SSO is not
          configured, you can use your CCMS password instead. However, for security reasons, using a token is strongly recommended regardless
          of w
  /v4/deployments/I9vA3KlK1331IYmEHhU/search:
    get:
      operationId: get_v4_deployments_I9vA3KlK1331IYmEHhU_search
      tags:
      - Deployments
      summary: GET /v4/deployments/I9vA3KlK1331IYmEHhU/search
      x-source: https://help.heretto.com/en/heretto-deploy-api/deploy-api-authentication
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV4DeploymentsI9Va3Klk1331IymehhuSearchResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl --location 'https://thunderbird.deploy.heretto.com/v4/deployments/I9vA3KlK1331IYmEHhU/search'  --header 'X-Deploy-API-Auth:\
          \ eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJodHRwczovL2pvcnNlay5jb20vY29udGVudC9hdWRpZW5jZXMiOlsicHJpdmF0ZSJdfQ.x7KlW9Z5jS6ImF1ZGllbmNlX2Ei'\
          \ \n URL Parameter Authentication \n https://thunderbird.deploy.heretto.com/v4/deployments/I9vA3KlK1331IYmEHhU/search?token=eyJhbGciOiJIUz"
  /v4/deployments/I9vA3KlK1331IYmEHhU/structure:
    get:
      operationId: get_v4_deployments_I9vA3KlK1331IYmEHhU_structure
      tags:
      - Deployments
      summary: GET /v4/deployments/I9vA3KlK1331IYmEHhU/structure
      x-source: https://help.heretto.com/en/heretto-deploy-api/deploy-api-authentication
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV4DeploymentsI9Va3Klk1331IymehhuStructureResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl --location 'https://thunderbird.deploy.heretto.com/v4/deployments/I9vA3KlK1331IYmEHhU/structure'  --header 'X-Deploy-API-Auth:\
          \ a59ac183a8bc4a848c92082f91b863dc' \n URL Parameter Authentication \n https://thunderbird.deploy.heretto.com/v4/deployments/I9vA3KlK1331IYmEHhU/structure?token=a59ac183a8bc4a848c92082f91b863dc\
          \ \n JWT \n Warning: \n Use the JWT signed with a JWT HS256 key, NOT the original J"
components:
  schemas:
    GetV4DeploymentsI9Va3Klk1331IymehhuSearchResponse:
      type: object
      properties:
        status:
          type: string
        data:
          type: object
    GetV4DeploymentsI9Va3Klk1331IymehhuStructureResponse:
      type: object
      properties:
        status:
          type: string
        data:
          type: object
  securitySchemes:
    basic:
      type: http
      scheme: basic
security:
- basic: []
tags:
- name: Cms
- name: Deployments
- name: Ezdnxtgen
- name: Tools