Zeebe Process Instances API
The Process Instances API from Zeebe — 3 operation(s) for process instances.
Zeebe Process Instances API is one of 9 APIs that Zeebe publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 2 JSON Schema definitions.
Tagged areas include Process Instances. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 2 JSON Schemas.
This API exposes 3 operations across 3 paths, and defines 2 schemas. It is described by OpenAPI 3.1.0, at version 8.6.0.
Requests are made against a single base URL, {baseUrl}/v2.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Zeebe 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 3
Across 3 paths, the API surfaces 3 operations — 1 DELETE, 2 POST. Each is listed below with its method, path, parameters, and response codes.
Schemas 2
The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are ProcessInstance (5 properties), CreateProcessInstanceRequest (5 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Zeebe 8
Other APIs Zeebe publishes across the network.