How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
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.2.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.2.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.

ProcessInstance
object
5 properties
SearchRequest
object
3 properties
CreateProcessInstanceRequest
object
5 properties
ProcessInstanceSearchResponse
object
2 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
Where this information came from

This is an independent, third-party profile of Camunda Process Instances API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.