Flowable Deployments API

The Deployments API from Flowable — 3 operation(s) for deployments.

OpenAPI Specification

flowable-api-deployments-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Flowable REST CMMN Deployments API
  version: 1.0.0
  description: Minimal OpenAPI description of the Flowable REST API, which exposes the Flowable Process Engine over HTTP for managing BPMN deployments, process definitions, process instances, tasks, and CMMN cases.
  x-generated-from: https://www.flowable.com/open-source/docs/bpmn/ch14-REST
  x-generated-by: claude-crawl-2026-05-08
servers:
- url: https://flowable.example.com/flowable-rest/service
  description: Default Flowable REST service base
tags:
- name: Deployments
paths:
  /repository/deployments:
    get:
      tags:
      - Deployments
      summary: List deployments
      operationId: listDeployments
      responses:
        '200':
          description: A list of deployments
          content:
            application/json:
              schema:
                type: object
    post:
      tags:
      - Deployments
      summary: Create a deployment
      operationId: createDeployment
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                type: object
  /repository/deployments/{deploymentId}:
    parameters:
    - in: path
      name: deploymentId
      required: true
      schema:
        type: string
    get:
      tags:
      - Deployments
      summary: Get a deployment
      operationId: getDeployment
      responses:
        '200':
          description: Deployment
          content:
            application/json:
              schema:
                type: object
    delete:
      tags:
      - Deployments
      summary: Delete a deployment
      operationId: deleteDeployment
      responses:
        '204':
          description: Deleted
  /repository/deployments/{deploymentId}/resources:
    get:
      tags:
      - Deployments
      summary: List deployment resources
      operationId: listDeploymentResources
      parameters:
      - in: path
        name: deploymentId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Resources
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object