Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Camunda Jobs API

The Jobs API from Camunda — 4 operation(s) for jobs.

Camunda Jobs API is one of 10 APIs that Camunda publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Jobs. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 4 operations across 4 paths, and defines 3 schemas. It is described by OpenAPI 3.1.0, at version 8.6.0.

Requests are made against a single base URL, {baseUrl}/v2.

4 operations 4 paths 3 schemas 4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
8.6.0
Server
{baseUrl}/v2
Authentication
HTTP Bearer
Contact
License
Resource Areas
1

Authentication & Security 1

Camunda Jobs API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). By default, every request must be authenticated.

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 4 POST. Each is listed below with its method, path, parameters, and response codes.

Jobs 4
POST
/jobs/activation
Activate jobs
activateJobs body → 200
POST
/jobs/{jobKey}/completion
Complete a job
completeJob 1 param body → 204
POST
/jobs/{jobKey}/failure
Fail a job
failJob 1 param body → 204
POST
/jobs/{jobKey}/error
Throw error for a job
throwError 1 param body → 204

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are Job (13 properties), ActivateJobsRequest (6 properties), FailJobRequest (4 properties). Each schema is shown below with its type and property counts.

Job
object
13 properties
ActivateJobsRequest
object
6 properties 3 required
FailJobRequest
object
4 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

camunda-jobs-api-openapi.yml Raw ↑

Other APIs Camunda publishes across the network.

Camunda Cluster API
Camunda Decisions API
Camunda Deployments API
Camunda Incidents API
Camunda Messages API
Camunda Process Definitions API
Camunda Process Instances API
Camunda Signals API
Camunda User Tasks API