Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Camunda Process Definitions API

The Process Definitions API from Camunda — 3 operation(s) for process definitions.

Camunda Process Definitions API is one of 10 APIs that Camunda publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Process Definitions. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 3 operations across 3 paths, and defines 3 schemas. It is described by OpenAPI 3.1.0, at version 8.6.0.

Requests are made against a single base URL, {baseUrl}/v2.

3 operations 3 paths 3 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
8.6.0
Server
{baseUrl}/v2
Authentication
HTTP Bearer
Contact
License
Resource Areas
1

Authentication & Security 1

Camunda Process Definitions API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). By default, every request must be authenticated.

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Process Definitions 3
POST
/process-definitions/search
Search process definitions
searchProcessDefinitions body → 200
GET
/process-definitions/{processDefinitionKey}
Get process definition
getProcessDefinition 1 param → 200
GET
/process-definitions/{processDefinitionKey}/xml
Get process definition XML
getProcessDefinitionXml 1 param → 200

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are ProcessDefinition (6 properties), SearchRequest (3 properties), ProcessDefinitionSearchResponse (2 properties). Each schema is shown below with its type and property counts.

ProcessDefinitionSearchResponse
object
2 properties
ProcessDefinition
object
6 properties
SearchRequest
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

camunda-process-definitions-api-openapi.yml Raw ↑

Other APIs Camunda publishes across the network.

Camunda Cluster API
Camunda Decisions API
Camunda Deployments API
Camunda Incidents API
Camunda Jobs API
Camunda Messages API
Camunda Process Instances API
Camunda Signals API
Camunda User Tasks API