Camunda Services Public API

openapi: 3.2.0
info:
  title: Camunda Services Public API
  version: '2026-10-06'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-06: 22 operation(s) read from 23 public documentation page(s) (each operation names its page in x-source). This is not the provider''s published contract; Camunda Services has published no machine-readable contract that the pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 8
    documentation: 14
    pages-with-code: 12
    pages-read: 23
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-06'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://docs.camunda.io/docs/reference/notices
  - https://docs.camunda.io/docs/next/reference/glossary
  - https://docs.camunda.io/docs/apis-tools/orchestration-cluster-api-rest/orchestration-cluster-api-rest-overview
  - https://docs.camunda.io/docs/apis-tools/migration-manuals/migrate-to-89
  - https://docs.camunda.io/docs/guides/getting-started-agentic-orchestration
  - https://docs.camunda.io/docs/8.8/guides/getting-started-agentic-orchestration
  - https://docs.camunda.io/docs/next/guides/getting-started-agentic-orchestration
  - https://docs.camunda.io/docs/8.8/self-managed/quickstart/developer-quickstart/c8run
  - https://docs.camunda.io/docs/8.8/reference/notices
  - https://docs.camunda.io/docs/next/reference/notices
  - https://docs.camunda.io/docs/apis-tools/administration-api/authentication
  - https://docs.camunda.io/docs/apis-tools/optimize-api/optimize-api-authentication
  - https://docs.camunda.io/docs/apis-tools/optimize-api/dashboard/get-dashboard-ids
  - https://docs.camunda.io/docs/apis-tools/optimize-api/report/get-report-ids
  - https://docs.camunda.io/docs/apis-tools/optimize-api/external-variable-ingestion
  - https://docs.camunda.io/docs/apis-tools/optimize-api/health-readiness
  - https://docs.camunda.io/docs/apis-tools/optimize-api/import-entities
  - https://docs.camunda.io/docs/apis-tools/optimize-api/variable-labeling
  - https://docs.camunda.io/docs/apis-tools/web-modeler-api/authentication
  - https://docs.camunda.io/docs/apis-tools/administration-sm-api/administration-sm-api-authentication
  - https://docs.camunda.io/docs/self-managed/operational-guides/troubleshooting
  - https://docs.camunda.io/docs/self-managed/components/orchestration-cluster/admin/overview
  - https://docs.camunda.io/docs/self-managed/operational-guides/backup-restore/backup-and-restore
servers:
- url: https://api.cloud.camunda.io
security:
- bearer: []
tags:
- name: Public
paths:
  /api/public/import:
    post:
      operationId: post_api_public_import
      tags:
      - Public
      summary: Import entities
      x-source: https://docs.camunda.io/docs/apis-tools/optimize-api/import-entities
      parameters:
      - name: collectionId
        in: query
        required: true
        schema:
          type: string
        description: The ID of the collection for which to retrieve the report IDs.
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
        description: Authentication token (Bearer).
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiPublicImportRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiPublicImportResponse'
      x-evidence:
        kind: documentation
  /api/public/variables/labels:
    post:
      operationId: post_api_public_variables_labels
      tags:
      - Public
      summary: Variable labeling
      x-source: https://docs.camunda.io/docs/apis-tools/optimize-api/variable-labeling
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiPublicVariablesLabelsRequest'
      responses:
        '204':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/public/{publicid}:
    get:
      operationId: get_api_public_publicid
      tags:
      - Public
      summary: Get dashboard IDs
      x-source: https://docs.camunda.io/docs/apis-tools/optimize-api/dashboard/get-dashboard-ids
      parameters:
      - name: publicid
        in: path
        required: true
        schema:
          type: string
      - name: collectionId
        in: query
        required: true
        schema:
          type: string
        description: The ID of the collection for which to retrieve the dashboard IDs.
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
        description: Bearer token for authentication.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiPublicPublicidResponse'
      x-evidence:
        kind: documentation
        collapsed_from: 2 example path(s) differing only at publicId
components:
  schemas:
    GetApiPublicPublicidResponse:
      type: object
      properties:
        id:
          type: string
          description: Dashboard identifier.
    PostApiPublicImportResponse:
      type: object
      properties:
        '200':
          type: array
          description: List of DTOs specifying the ID and entity type (report or dashboard) of each newly created entity.
        '400':
          type: string
          description: The provided list of entities is invalid.
        '401':
          type: string
          description: Secret incorrect or missing in HTTP header.
        '404':
          type: string
          description: The given target collection ID does not exist.
        '500':
          type: string
          description: Some error occurred while processing the request.
    PostApiPublicVariablesLabelsRequest:
      type: object
      properties:
        definitionKey:
          type: string
          description: Reference to the process definition using its key
        labels:
          type: array
          description: Array of variable label objects
        labels[].variableName:
          type: string
          description: Name of the variable
        labels[].variableType:
          type: string
          description: Type of the variable (e.g., Boolean, String, Long)
        labels[].variableLabel:
          type: string
          description: Label value for the variable (empty string deletes the label)
      required:
      - definitionKey
      - labels
      - labels[].variableName
      - labels[].variableType
      - labels[].variableLabel
    PostApiPublicImportRequest:
      type: object
      properties:
        body:
          type: array
          description: JSON array of entity definitions to be imported.
      required:
      - body
  securitySchemes:
    bearer:
      type: http
      scheme: bearer