Camunda Services self managed API

openapi: 3.1.0
info:
  title: Camunda Services self managed API
  version: '2026-10-06'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-06: 4 operation(s) read from 3 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/self-managed/components/orchestration-cluster/admin/overview
  - https://docs.camunda.io/docs/self-managed/operational-guides/backup-restore/backup-and-restore
  - https://docs.camunda.io/docs/self-managed/operational-guides/troubleshooting
  x-docs-section: self-managed
servers:
- url: https://api.cloud.camunda.io
paths:
  /:
    get:
      operationId: get
      tags:
      - Api
      summary: GET /
      x-source: https://docs.camunda.io/docs/self-managed/operational-guides/backup-restore/backup-and-restore
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl , jq , and kubectl . \n Considerations ​ \n Backup IDs (Elasticsearch / OpenSearch path only) ​ \n When using Elasticsearch\
          \ or OpenSearch as secondary storage, each component backup is identified by a user-supplied integer backup ID. The backup ID must be\
          \ greater than the ID of any previous backup. \n note We recommend using the Unix timestamp as the backup ID. \n note When using the\
          \ RDBMS path, b"
  /actuator/loggers/com.azure:
    post:
      operationId: post_actuator_loggers_com_azure
      tags:
      - Actuator
      summary: POST /actuator/loggers/com.azure
      x-source: https://docs.camunda.io/docs/self-managed/operational-guides/troubleshooting
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostActuatorLoggersComAzureRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl 'http://localhost:9600/actuator/loggers/com.azure' -i -X POST -H 'Content-Type: application/json' -d '{\"configuredLevel\"\
          :\"debug\"}' \n Add the following environment variable to the Zeebe Broker StatefulSet. \n AZURE_HTTP_LOG_DETAIL_LEVEL=BASIC \n Zeebe\
          \ Ingress (gRPC) ​ \n Zeebe requires an Ingress controller that supports gRPC which is built on top of HTTP/2 transport layer. Therefore,\
          \ to expose Z"
  /v1/process-definitions/search:
    post:
      operationId: post_v1_process_definitions_search
      tags:
      - Process Definitions
      summary: POST /v1/process-definitions/search
      x-source: https://docs.camunda.io/docs/self-managed/components/orchestration-cluster/admin/overview
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl --request POST ''http://localhost:8080/v1/process-definitions/search'' \ -u demo:demo \ --header ''Content-Type: application/json''
          \ --data-raw ''{}'' Was this helpful? Copy page link Edit this page Previous User task access restrictions Next Connect to an identity
          provider Initial setup Configure initial users Option 1: Create an initial admin user in Orchestration Cluster UI Option 2: Create an '
  /v2/setup/user:
    post:
      operationId: post_v2_setup_user
      tags:
      - Setup
      summary: Create an initial admin user via the Setup endpoint of Orchestration Cluster REST API
      x-source: https://docs.camunda.io/docs/self-managed/components/orchestration-cluster/admin/overview
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostV2SetupUserRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
security:
- bearer: []
components:
  schemas:
    PostActuatorLoggersComAzureRequest:
      type: object
      properties:
        configuredLevel:
          type: string
    PostV2SetupUserRequest:
      type: object
      properties:
        username:
          type: string
          description: your chosen username
        password:
          type: string
          description: your chosen password
        name:
          type: string
          description: the user's full name
        email:
          type: string
          description: the user's email address
      required:
      - username
      - password
      - name
      - email
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
tags:
- name: Actuator
- name: Api
- name: Process Definitions
- name: Setup