Zeebe

Zeebe Resources API

The Resources API from Zeebe — 1 operation(s) for resources.

GitHub OpenAPI

Documentation

📖
Documentation
https://docs.camunda.io/docs/apis-tools/zeebe-api-rest/zeebe-api-rest-overview/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/zeebe/refs/heads/main/openapi/zeebe-resources-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/zeebe/refs/heads/main/json-schema/
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/zeebe/refs/heads/main/json-structure/

Other Resources

🔗
Postman
https://www.postman.com/camundateam/camunda-8-postman/collection/j0knqwp/zeebe-api-rest
🔗
SpectralRules
https://raw.githubusercontent.com/api-evangelist/zeebe/refs/heads/main/rules/zeebe-rules.yml
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/zeebe/refs/heads/main/examples/
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/zeebe/refs/heads/main/json-ld/zeebe-context.jsonld
🔗
Vocabulary
https://raw.githubusercontent.com/api-evangelist/zeebe/refs/heads/main/vocabulary/zeebe-vocabulary.yml
🔗
Capabilities
https://raw.githubusercontent.com/api-evangelist/zeebe/refs/heads/main/capabilities/

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/zeebe-resources-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

zeebe-resources-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Zeebe REST Cluster Resources API
  description: The Zeebe REST API provides endpoints for interacting with the Zeebe workflow engine that powers Camunda 8, including process deployment, instance management, job handling, and cluster topology queries.
  version: 8.6.0
  contact:
    name: Camunda
    url: https://camunda.com/
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: '{baseUrl}/v2'
  description: Zeebe Gateway REST API
  variables:
    baseUrl:
      default: http://localhost:8080
security:
- BearerAuth: []
tags:
- name: Resources
paths:
  /resources/deletion:
    post:
      operationId: deleteResource
      summary: Zeebe Delete a Resource
      description: Deletes a deployed resource (process, decision, or form).
      tags:
      - Resources
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - resourceKey
              properties:
                resourceKey:
                  type: integer
                  format: int64
            examples:
              DeleteResourceRequestExample:
                summary: Default deleteResource request
                x-microcks-default: true
                value:
                  resourceKey: 100
      responses:
        '204':
          description: Resource deleted
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer