{"id":17218247,"url":"https://github.com/korthout/camunda-platform-rest-api","last_synced_at":"2026-07-06T16:30:22.024Z","repository":{"id":65843658,"uuid":"549232517","full_name":"korthout/camunda-platform-rest-api","owner":"korthout","description":"A REST API for Camunda Platform 8","archived":true,"fork":false,"pushed_at":"2024-09-09T15:27:05.000Z","size":4531,"stargazers_count":26,"open_issues_count":15,"forks_count":3,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-02-12T13:17:43.352Z","etag":null,"topics":["camunda","camunda-platform-8","openapi","rest","rest-api","restapi"],"latest_commit_sha":null,"homepage":"https://korthout.github.io/camunda-platform-rest-api/","language":"Kotlin","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/korthout.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2022-10-10T22:06:19.000Z","updated_at":"2024-11-07T04:47:16.000Z","dependencies_parsed_at":"2024-02-28T11:29:17.204Z","dependency_job_id":"8c314a2d-dcb6-4e43-befa-90c5cf6cf0ab","html_url":"https://github.com/korthout/camunda-platform-rest-api","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/korthout%2Fcamunda-platform-rest-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/korthout%2Fcamunda-platform-rest-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/korthout%2Fcamunda-platform-rest-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/korthout%2Fcamunda-platform-rest-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/korthout","download_url":"https://codeload.github.com/korthout/camunda-platform-rest-api/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240445150,"owners_count":19802398,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["camunda","camunda-platform-8","openapi","rest","rest-api","restapi"],"created_at":"2024-10-15T03:45:53.089Z","updated_at":"2026-07-06T16:30:21.953Z","avatar_url":"https://github.com/korthout.png","language":"Kotlin","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e\n  \u003cp align=\"center\"\u003eCamunda Platform REST API\u003c/p\u003e\n\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/camunda-community-hub/community\"\u003e\u003cimg src=\"https://img.shields.io/badge/Community%20Extension-An%20open%20source%20community%20maintained%20project-FF4700\" alt=\"Community Extension\" /\u003e\u003c/a\u003e\n  \u003cbr/\u003e\n  \u003ca href=\"https://camunda.com/platform/\"\u003e\u003cimg src=\"https://img.shields.io/badge/Compatible%20with-Camunda%20Platform%208-0072Ce\" alt=\"Compatible with: Camunda Platform 8\" /\u003e\u003c/a\u003e\n  \u003ca href=\"https://github.com/Camunda-Community-Hub/community/blob/main/extension-lifecycle.md#Unmaintained-\"\u003e\u003cimg src=\"https://img.shields.io/badge/Lifecycle-Unmaintained-lightgrey\" alt=\"Lifecycle: Unmaintained\" /\u003e\u003c/a\u003e\n  \u003cimg alt=\"GitHub\" src=\"https://img.shields.io/github/license/korthout/camunda-platform-rest-api?label=License\" alt=\"Licence: Apache-2.0\"\u003e\n\u003c/p\u003e\n\n\u003e [!WARNING]\n\u003e **This project is unmaintained** - There are ongoing efforts to add a REST API to Zeebe and ideas about unifying the REST APIs of all Camunda Platform 8 components.\n\u003e With that, it's time to sunset this project.\n\u003e\n\u003e Working on this project has taught me much about Spring and Kotlin and even more about REST APIs.\n\u003e I'm proud that Camunda is taking a path that was explored by this project and took note of our successes and mistakes to make a better product.\n\u003e\n\u003e Thank you all for all your feedback and support.\n\u003e Happy RESTful orchestrating!\n\n## Introduction\n\nCamunda Platform REST API is a REST API to interact with [Camunda Platform 8](https://camunda.com/platform/).\n\nCamunda Platform 8 has multiple different APIs.\nTypically, one for each component.\nThere are gRPC, GraphQL, and REST APIs for you to connect to and learn, which can be difficult and time consuming.\nCamunda Platform REST API offers a single consistent REST API to interact with Camunda Platform 8.\n\n- Get Started Quickly\n\n\u003e Camunda Platform REST API was designed to be easily installed, to get you connected to [Camunda Platform 8](https://camunda.com/platform/) quickly.\n\n- Easy to Use\n\n\u003e Thanks to a consistent API design and an [OpenAPI](https://www.openapis.org/) specification, you can focus on interacting with Camunda Platform 8.\n\n- Community Driven\n\n\u003e This project is community maintained. We welcome [contributions](https://github.com/korthout/camunda-platform-rest-api/blob/main/CONTRIBUTING.md) for feature requests and bug reports, as well as for docs and code changes.\n\n### API\n\n| Method  |          Resource          |                Description                 |\n|---------|----------------------------|--------------------------------------------|\n| `GET`   | `/status`                  | Retrieve the Topology of a Zeebe cluster   |\n| `POST`  | `/process-instances`       | Create a new Process Instance              |\n| `GET`   | `/process-instances/{key}` | Retrieve the details of a Process Instance |\n| `GET`   | `/jobs`                    | Activate Jobs                              |\n| `PATCH` | `/jobs/{key}`              | Update a Job                               |\n| ..      | ..                         | Not yet implemented                        |\n\nYou can find the full API reference documentation in the [`openapi.yaml`](openapi.yaml) specification, and in the [Docs](https://korthout.github.io/camunda-platform-rest-api/).\n\n## Getting Started\n\nThe easiest way to start the Camunda Platform REST API is using Docker.\n\n```shell\ndocker pull ghcr.io/korthout/camunda-platform-rest-api:latest\n```\n\nUsing the provided [Docker Compose file](./docker/docker-compose.yml) you can start a new local Camunda Platform 8 cluster and connect the Camunda Platform REST API to it.\nThis is a great way to try out the Camunda Platform REST API before connecting it to your production cluster.\n\n```shell\ndocker compose -f ./docker/docker-compose.yml up -d\n```\n\nOnce running, you can try it out the REST API.\n\n```shell\ncurl localhost:8080/status\n```\n\nOr, explore the API in Swagger UI running at [/swagger-ui](http://localhost:8080/swagger-ui.html).\n\n## Documentation\n\nRead the [docs](https://korthout.github.io/camunda-platform-rest-api/) for any further information:\n- [Connect to a cluster](https://korthout.github.io/camunda-platform-rest-api/docs/guides/connection)\n- [Configuration](https://korthout.github.io/camunda-platform-rest-api/docs/guides/config)\n- [API](https://korthout.github.io/camunda-platform-rest-api/docs/api)\n\n## Acknowledgements\n\nThis software would not be possible without these awesome projects:\n\n- [Spring Zeebe](https://github.com/camunda-community-hub/spring-zeebe)\n  \\- Easily use the Zeebe Java Client in your Spring or Spring Boot projects\n- [Camunda Operate Client](https://github.com/camunda-community-hub/camunda-operate-client-java)\n  \\- Simplified Java client for the Operate API of Camunda Platform 8\n- [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator)\n  \\- Generate clients, servers, and documentation from OpenAPI 2.0/3.x documents\n- [Docusaurus OpenAPI Doc Generator](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs)\n  \\- OpenAPI plugin for generating API reference docs in Docusaurus v2.\n- [kotlin-duration-string](https://github.com/blueanvil/kotlin-duration-string)\n  \\- A tiny Kotlin library for dealing with human-readable duration strings like `2h 45m 50s`\n\nA full list of projects we depend on can be found in the [pom file](pom.xml).\n\n## License\n\nCamunda Platform REST API is Open Source software released under the [Apache 2.0 license](https://www.apache.org/licenses/LICENSE-2.0.html).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkorthout%2Fcamunda-platform-rest-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkorthout%2Fcamunda-platform-rest-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkorthout%2Fcamunda-platform-rest-api/lists"}