Zeebe REST API — Process Instances

naftiko: 1.0.0-alpha2
info:
  label: Zeebe REST API — Process Instances
  description: 'Zeebe REST API — Process Instances. 3 operations. Lead operation: Zeebe Create a Process Instance. Self-contained
    Naftiko capability covering one Zeebe business surface.'
  tags:
  - Zeebe
  - Process Instances
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    ZEEBE_API_KEY: ZEEBE_API_KEY
capability:
  consumes:
  - type: http
    namespace: zeebe-process-instances
    baseUri: ''
    description: Zeebe REST API — Process Instances business capability. Self-contained, no shared references.
    resources:
    - name: process-instances
      path: /process-instances
      operations:
      - name: createprocessinstance
        method: POST
        description: Zeebe Create a Process Instance
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: process-instances-processInstanceKey
      path: /process-instances/{processInstanceKey}
      operations:
      - name: cancelprocessinstance
        method: DELETE
        description: Zeebe Cancel a Process Instance
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: processInstanceKey
          in: path
          type: integer
          required: true
    - name: process-instances-processInstanceKey-migration
      path: /process-instances/{processInstanceKey}/migration
      operations:
      - name: migrateprocessinstance
        method: POST
        description: Zeebe Migrate a Process Instance
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: processInstanceKey
          in: path
          type: integer
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: bearer
      token: '{{env.ZEEBE_API_KEY}}'
  exposes:
  - type: rest
    namespace: zeebe-process-instances-rest
    port: 8080
    description: REST adapter for Zeebe REST API — Process Instances. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/process-instances
      name: process-instances
      description: REST surface for process-instances.
      operations:
      - method: POST
        name: createprocessinstance
        description: Zeebe Create a Process Instance
        call: zeebe-process-instances.createprocessinstance
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/process-instances/{processinstancekey}
      name: process-instances-processinstancekey
      description: REST surface for process-instances-processInstanceKey.
      operations:
      - method: DELETE
        name: cancelprocessinstance
        description: Zeebe Cancel a Process Instance
        call: zeebe-process-instances.cancelprocessinstance
        with:
          processInstanceKey: rest.processInstanceKey
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/process-instances/{processinstancekey}/migration
      name: process-instances-processinstancekey-migration
      description: REST surface for process-instances-processInstanceKey-migration.
      operations:
      - method: POST
        name: migrateprocessinstance
        description: Zeebe Migrate a Process Instance
        call: zeebe-process-instances.migrateprocessinstance
        with:
          processInstanceKey: rest.processInstanceKey
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: zeebe-process-instances-mcp
    port: 9090
    transport: http
    description: MCP adapter for Zeebe REST API — Process Instances. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: zeebe-create-process-instance
      description: Zeebe Create a Process Instance
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: zeebe-process-instances.createprocessinstance
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: zeebe-cancel-process-instance
      description: Zeebe Cancel a Process Instance
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: zeebe-process-instances.cancelprocessinstance
      with:
        processInstanceKey: tools.processInstanceKey
      outputParameters:
      - type: object
        mapping: $.
    - name: zeebe-migrate-process-instance
      description: Zeebe Migrate a Process Instance
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: zeebe-process-instances.migrateprocessinstance
      with:
        processInstanceKey: tools.processInstanceKey
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.