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 Instances API

The Process Instances API from Camunda — 3 operation(s) for process instances.

Camunda Process Instances 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 Instances. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

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

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

4 operations 3 paths 4 schemas 1 DELETE1 GET2 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 Instances API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). By default, every request must be authenticated.

Paths & Operations 4

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

Process Instances 4
POST
/process-instances
Create a process instance
createProcessInstance body → 200
POST
/process-instances/search
Search process instances
searchProcessInstances body → 200
GET
/process-instances/{processInstanceKey}
Get process instance
getProcessInstance 1 param → 200
DELETE
/process-instances/{processInstanceKey}
Cancel a process instance
cancelProcessInstance 1 param → 204

Schemas 4

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

ProcessInstanceSearchResponse
object
2 properties
SearchRequest
object
3 properties
ProcessInstance
object
5 properties
CreateProcessInstanceRequest
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

camunda-process-instances-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 Definitions API
Camunda Signals API
Camunda User Tasks API