Camunda Services apis tools API

openapi: 3.1.0
info:
  title: Camunda Services apis tools API
  version: '2026-10-06'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-06: 16 operation(s) read from 10 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/apis-tools/administration-api/authentication
  - https://docs.camunda.io/docs/apis-tools/migration-manuals/migrate-to-89
  - https://docs.camunda.io/docs/apis-tools/optimize-api/dashboard/get-dashboard-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/optimize-api-authentication
  - https://docs.camunda.io/docs/apis-tools/optimize-api/variable-labeling
  - https://docs.camunda.io/docs/apis-tools/orchestration-cluster-api-rest/orchestration-cluster-api-rest-overview
  - https://docs.camunda.io/docs/apis-tools/web-modeler-api/authentication
  x-docs-section: apis-tools
servers:
- url: https://api.cloud.camunda.io
paths:
  /${CLUSTER_ID}/v2:
    get:
      operationId: get_CLUSTER_ID_v2
      tags:
      - Cluster Id
      summary: GET /${CLUSTER_ID}/v2
      x-source: https://docs.camunda.io/docs/apis-tools/orchestration-cluster-api-rest/orchestration-cluster-api-rest-overview
      parameters:
      - name: CLUSTER_ID
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl https:// ${CLUSTER_ID} . ${REGION_ID} .privateconnectivity.camunda.io/api/v2/topology \n Replace the placeholders with\
          \ the values for your environment.\nSee Base URLs for details on SaaS (public and secure connectivity) and self-managed setups. \n Using\
          \ Postman ​ \n Try the get cluster topology request or browse the full collection. \n This request returns information about your cluster\
          \ topology, "
  /api/ingestion/variable:
    post:
      operationId: post_api_ingestion_variable
      tags:
      - Api
      summary: External variable ingestion
      x-source: https://docs.camunda.io/docs/apis-tools/optimize-api/external-variable-ingestion
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiIngestionVariableRequest'
      responses:
        '204':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/public/import:
    post:
      operationId: post_api_public_import
      tags:
      - Api
      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:
      - Api
      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:
      - Api
      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
  /api/readyz:
    get:
      operationId: get_api_readyz
      tags:
      - Api
      summary: Health readiness
      description: The response is an empty body with the status code indicating the readiness of Optimize.
      x-source: https://docs.camunda.io/docs/apis-tools/optimize-api/health-readiness
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v1/info:
    get:
      operationId: get_api_v1_info
      tags:
      - Api
      summary: Authentication
      x-source: https://docs.camunda.io/docs/apis-tools/web-modeler-api/authentication
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV1InfoResponse'
      x-evidence:
        kind: documentation
  /auth/realms/camunda-platform/protocol/openid-connect/token:
    post:
      operationId: post_auth_realms_camunda_platform_protocol_openid_connect_token
      tags:
      - Auth
      summary: POST /auth/realms/camunda-platform/protocol/openid-connect/token
      x-source: https://docs.camunda.io/docs/apis-tools/optimize-api/optimize-api-authentication
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostAuthRealmsCamundaPlatformProtocolOpenidConnectTokenRespo'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl --location --request POST 'http://localhost:18080/auth/realms/camunda-platform/protocol/openid-connect/token' \\ --header\
          \ 'Content-Type: application/x-www-form-urlencoded' \\ --data-urlencode \"client_id= ${CLIENT_ID} \" \\ --data-urlencode \"client_secret=\
          \ ${CLIENT_SECRET} \" \\ --data-urlencode 'grant_type=client_credentials' \n A successful authentication response looks like the following:\
          \ \n { \"acc"
  /deployments:
    post:
      operationId: post_deployments
      tags:
      - Deployments
      summary: Deploy the process – Use POST /deployments to deploy your BPMN file
      x-source: https://docs.camunda.io/docs/apis-tools/orchestration-cluster-api-rest/orchestration-cluster-api-rest-overview
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /members:
    get:
      operationId: get_members
      tags:
      - Members
      summary: GET /members
      x-source: https://docs.camunda.io/docs/apis-tools/administration-api/authentication
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetMembersResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl --header \"Authorization: Bearer ${TOKEN} \" \\ https://api.cloud.camunda.io/members \n A successful response includes\
          \ a list of organization members . For example: \n [ { \"name\" : \"User Userton\" , \"email\" : \"user@example.com\" , \"roles\" :\
          \ [ \"admin\" ] , \"invitePending\" : false } ] \n Token expiration ​ \n Access tokens expire according to the expires_in property of\
          \ a successful authentication respons"
  /process-instances:
    post:
      operationId: post_process_instances
      tags:
      - Process Instances
      summary: Start a process instance – Use POST /process-instances to create a new process instance
      x-source: https://docs.camunda.io/docs/apis-tools/orchestration-cluster-api-rest/orchestration-cluster-api-rest-overview
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /resources/{resourcekey}/deletion:
    post:
      operationId: post_resources_resourcekey_deletion
      tags:
      - Resources
      summary: Resource deletion endpoint now returns a response body
      description: The endpoint now returns a JSON response body instead of an empty 204 response.
      x-source: https://docs.camunda.io/docs/apis-tools/migration-manuals/migrate-to-89
      parameters:
      - name: resourcekey
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /user-tasks/{usertaskkey}/{id}:
    post:
      operationId: post_user_tasks_usertaskkey_id
      tags:
      - User Tasks
      summary: Assign a user task – POST /user-tasks/{userTaskKey}/assignment
      x-source: https://docs.camunda.io/docs/apis-tools/orchestration-cluster-api-rest/orchestration-cluster-api-rest-overview
      parameters:
      - name: usertaskkey
        in: path
        required: true
        schema:
          type: string
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
        collapsed_from: 2 example path(s) differing only at id
  /v2/deployments:
    post:
      operationId: post_v2_deployments
      tags:
      - Deployments
      summary: Deploy a BPMN file – The default maximum request size for POST /v2/deployments is 4MB
      x-source: https://docs.camunda.io/docs/apis-tools/orchestration-cluster-api-rest/orchestration-cluster-api-rest-overview
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v2/topology:
    get:
      operationId: get_v2_topology
      tags:
      - Topology
      summary: GET /v2/topology
      x-source: https://docs.camunda.io/docs/apis-tools/orchestration-cluster-api-rest/orchestration-cluster-api-rest-overview
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl http://localhost:8080/v2/topology \n SaaS, public connectivity: "
  /v2/user-tasks/search:
    post:
      operationId: post_v2_user_tasks_search
      tags:
      - User Tasks
      summary: Advanced search and filtering – Query process data with powerful search capabilities
      x-source: https://docs.camunda.io/docs/apis-tools/orchestration-cluster-api-rest/orchestration-cluster-api-rest-overview
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
security:
- bearer: []
components:
  schemas:
    PostApiIngestionVariableRequest:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of this variable.
        name:
          type: string
          description: The name of the variable.
        type:
          type: string
          description: 'The type of the variable. Must be one of: String, Short, Long, Double, Integer, Boolean, or Date.'
        value:
          type: string
          description: The current value of the variable.
        processInstanceId:
          type: string
          description: The ID of the process instance this variable is to be associated with.
        processDefinitionKey:
          type: string
          description: The definition key of the process instance this variable is to be associated with.
      required:
      - id
      - name
      - type
      - value
      - processInstanceId
      - processDefinitionKey
    PostApiPublicImportRequest:
      type: object
      properties:
        body:
          type: array
          description: JSON array of entity definitions to be imported.
      required:
      - body
    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
    GetApiPublicPublicidResponse:
      type: object
      properties:
        id:
          type: string
          description: Dashboard identifier.
    GetApiV1InfoResponse:
      type: object
      properties:
        version:
          type: string
          description: API version
        authorizedOrganization:
          type: string
          description: ID of the authorized organization
        createPermission:
          type: boolean
          description: Create permission flag
        readPermission:
          type: boolean
          description: Read permission flag
        updatePermission:
          type: boolean
          description: Update permission flag
        deletePermission:
          type: boolean
          description: Delete permission flag
    PostAuthRealmsCamundaPlatformProtocolOpenidConnectTokenRespo:
      type: object
      properties:
        access_token:
          type: string
        expires_in:
          type: integer
        refresh_expires_in:
          type: integer
        token_type:
          type: string
        not-before-policy:
          type: integer
    GetMembersResponse:
      type: object
      properties:
        name:
          type: string
        email:
          type: string
        roles:
          type: array
          items:
            type: string
        invitePending:
          type: boolean
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
tags:
- name: Api
- name: Auth
- name: Cluster Id
- name: Deployments
- name: Members
- name: Process Instances
- name: Resources
- name: Topology
- name: User Tasks