API documentation reference

REST API basics

Get data Post data Update data Delete data

Create a collection Get a collection Delete a collection Update a collection Get all collections

Administration API (REST)

Clusters-{cluster Uuid}-Clients-{client Id}

Get client Delete client

Clusters-{cluster Uuid}-Clients

Get clients Create client

Clusters-{cluster Uuid}-Backups-{backup Id}

Irreversibly deletes a cluster

Clusters-{cluster Uuid}-Backups

Get backup Create backup

Clusters-{cluster Uuid}-IP allowlist

Updates the IP allowlist rules for your cluster. Each entry in the array must be a valid comma separated list of CIDRs.

Clusters-{cluster Uuid}-Secrets-{secretName}

Irreversibly deletes a secret

Clusters-{cluster Uuid}-Secrets

Creates a new secret Get secret

Clusters-{cluster Uuid}

Get cluster Delete cluster PATCH :clusteruuid

Get clusters Create cluster Get parameters

Members-{email}

Create member Delete member

Administration API (Self-Managed)

Get usage metrics for clusters

Get current clusters

Camunda 8 API (REST)

Get cluster typology

Activate jobs Fail job Report error for job Complete job

Complete a user task Assign a user task Update a user task Unassign a user task Query user tasks (experimental)

Resolve incident

Process instance

Query process instances (experimental)

Decision definition

Query decision definitions (experimental)

Camunda 8 BPMN templates

Find Linemanager Remind Line Manager Log Absence Notify Employee Send Enquiry Response Send Escalation Email Reserve Seats Request Payment Generate Ticket

Operate Public API (SaaS)

Process definitions

Search for process definitions Get process definition by key Get process defintion by key as XML

Process instances

Search for process instances Get process instance by key Delete process instance and dependant data by key Get flow node statistic by process instance id Get sequence flows of process instance by key

Search for incidents Get incident by key

Flow node instances

Search for flow node instances Get flow node instance by key

Search for variables Get variable by key

Decision definitions

Search for decision definitions Get decision definition by key

Decision requirements

Search for decision requirements Get decision requirements by key Get decision requirements by key as XML

Decision instances

Search for decision instances Get decision instance by key

Operate Public API (Self-Managed)

Process definitions

Search for process definitions Get process definition by key Get process defintion by key as XML

Process instances

Search for process instances Get process instance by key Delete process instance and dependant data by key

Search for incidents Get incident by key

Flow node instances

Search for flow node instances Get flow node instance by key

Search for variables Get variable by key

Decision definitions

Search for decision definitions Get decision definition by key

Decision requirements

Search for decision requirements Get decision requirements by key Get decision requirements by key as XML

Decision instances

Search for decision instances Get decision instance by key

Optimize Public API

Get dashboard IDs Delete dashboard Export dashboard definitions

Get report IDs Delete report Export report definitions Export report result data

External variable ingestion

External variable ingestion

Health readiness

Health readiness

Import entities

Import entities

Event ingestion

Event ingestion

Enable sharing Disable sharing

Variable labeling

Variable labeling

Tasklist Public API (GraphQL)

Tasklist Public API (REST)

v1-variables-{variableId}

Get the variable details by variable id.

v1-tasks-{taskId}-variables-search

Returns the list of task variables

v1-tasks-{taskId}-variables

Save draft variables for a task

v1-tasks-{taskId}-unassign

Unassign a task with provided id. Returns the task.

v1-tasks-{taskId}-complete

Complete a task with taskId and optional variables. Returns the task.

v1-tasks-{taskId}-assign

Assign a task with id to assignee. Returns the task.

v1-tasks-{taskId}

Get one task by id. Returns task or error when task does not exist.

v1-tasks-search

Returns the list of tasks that satisfy search request params Copy

v1-forms-{formId}

Get the form details by form id and processDefinitionKey.

Web Modeler public API (REST)

Zeebe API (REST)

Cluster topology

Complete a user task Assign a user task Update a user task Unassign a user task

Zeebe API (gRPC)

API documentation reference

REST API basics

Get data Post data Update data Delete data

Create a collection Get a collection Delete a collection Update a collection Get all collections

Administration API (REST)

Clusters-{cluster Uuid}-Clients-{client Id}

Get client Delete client

Clusters-{cluster Uuid}-Clients

Get clients Create client

Clusters-{cluster Uuid}-Backups-{backup Id}

Irreversibly deletes a cluster

Clusters-{cluster Uuid}-Backups

Get backup Create backup

Clusters-{cluster Uuid}-IP allowlist

Updates the IP allowlist rules for your cluster. Each entry in the array must be a valid comma separated list of CIDRs.

Clusters-{cluster Uuid}-Secrets-{secretName}

Irreversibly deletes a secret

Clusters-{cluster Uuid}-Secrets

Creates a new secret Get secret

Clusters-{cluster Uuid}

Get cluster Delete cluster PATCH :clusteruuid

Get clusters Create cluster Get parameters

Members-{email}

Create member Delete member

Administration API (Self-Managed)

Get usage metrics for clusters

Get current clusters

Camunda 8 API (REST)

Get cluster typology

Activate jobs Fail job Report error for job Complete job

Complete a user task Assign a user task Update a user task Unassign a user task Query user tasks (experimental)

Resolve incident

Process instance

Query process instances (experimental)

Decision definition

Query decision definitions (experimental)

Camunda 8 BPMN templates

Find Linemanager Remind Line Manager Log Absence Notify Employee Send Enquiry Response Send Escalation Email Reserve Seats Request Payment Generate Ticket

Operate Public API (SaaS)

Process definitions

Search for process definitions Get process definition by key Get process defintion by key as XML

Process instances

Search for process instances Get process instance by key Delete process instance and dependant data by key Get flow node statistic by process instance id Get sequence flows of process instance by key

Search for incidents Get incident by key

Flow node instances

Search for flow node instances Get flow node instance by key

Search for variables Get variable by key

Decision definitions

Search for decision definitions Get decision definition by key

Decision requirements

Search for decision requirements Get decision requirements by key Get decision requirements by key as XML

Decision instances

Search for decision instances Get decision instance by key

Operate Public API (Self-Managed)

Process definitions

Search for process definitions Get process definition by key Get process defintion by key as XML

Process instances

Search for process instances Get process instance by key Delete process instance and dependant data by key

Search for incidents Get incident by key

Flow node instances

Search for flow node instances Get flow node instance by key

Search for variables Get variable by key

Decision definitions

Search for decision definitions Get decision definition by key

Decision requirements

Search for decision requirements Get decision requirements by key Get decision requirements by key as XML

Decision instances

Search for decision instances Get decision instance by key

Optimize Public API

Get dashboard IDs Delete dashboard Export dashboard definitions

Get report IDs Delete report Export report definitions Export report result data

External variable ingestion

External variable ingestion

Health readiness

Health readiness

Import entities

Import entities

Event ingestion

Event ingestion

Enable sharing Disable sharing

Variable labeling

Variable labeling

Tasklist Public API (GraphQL)

Tasklist Public API (REST)

v1-variables-{variableId}

Get the variable details by variable id.

v1-tasks-{taskId}-variables-search

Returns the list of task variables

v1-tasks-{taskId}-variables

Save draft variables for a task

v1-tasks-{taskId}-unassign

Unassign a task with provided id. Returns the task.

v1-tasks-{taskId}-complete

Complete a task with taskId and optional variables. Returns the task.

v1-tasks-{taskId}-assign

Assign a task with id to assignee. Returns the task.

v1-tasks-{taskId}

Get one task by id. Returns task or error when task does not exist.

v1-tasks-search

Returns the list of tasks that satisfy search request params Copy

v1-forms-{formId}

Get the form details by form id and processDefinitionKey.

Web Modeler public API (REST)

Zeebe API (REST)

Cluster topology

Complete a user task Assign a user task Update a user task Unassign a user task

Zeebe API (gRPC)

Home Optimize Public API ReportExport report definitions

Export report definitions

POST {{optimizeApiBaseUrl}}/api/public/export/report/definition/json

Request Body

["reportID", "reportID"]

Export report result data