Overview

Introduction

The Zeebe REST API is a REST API designed to interact with the Zeebe workflow engine.

note

Ensure you authenticate before accessing the Zeebe REST API.

Context paths

SaaS

Find your region Id and cluster Id under Connection information in your client credentials (revealed when you click on your client under the API tab within your cluster).

Example path: https://${REGION}.api.camunda.io:443/${CLUSTER_ID}/v1/

Self-Managed

Use the host and path defined for your Zeebe GatewayZeebe GatewayThe Zeebe Gateway is a component of the Zeebe cluster; it can be considered the contact point for the Zeebe cluster that allows Zeebe clients to communicate with Zeebe brokers inside a Zeebe cluster.. For Ingress and routing details, see the configuration guide. The path used here is the default.

Example path: http://localhost:8080/v1/

API Explorer

See the interactive Zeebe REST API Explorer for specifications, example requests and responses, and code samples of interacting with the Tasklist REST API.