Getting started

The easiest way to start the Camunda Platform REST API is using Docker.

docker pull ghcr.io/korthout/camunda-platform-rest-api:latest

Using the provided Docker Compose file you can start a new local Camunda Platform 8 cluster and connect the Camunda Platform REST API to it. This is a great way to try out the Camunda Platform REST API before connecting it to your production cluster.

docker compose -f ./docker/docker-compose.yml up -d

Once running, you can try out the REST API.

curl localhost:8080/status

Next steps

• connect to cluster
• explore the API docs
• play around with the API in Swagger UI (running at /swagger-ui).