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 Deployments API

The Deployments API from Camunda — 2 operation(s) for deployments.

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

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

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

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

2 operations 2 paths 2 schemas 2 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 Deployments API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). By default, every request must be authenticated.

Paths & Operations 2

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

Deployments 2
POST
/deployments
Deploy resources
createDeployment body → 200
POST
/deployments/search
Search deployments
searchDeployments body → 200

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are DeploymentResponse (3 properties), SearchRequest (3 properties). Each schema is shown below with its type and property counts.

SearchRequest
object
3 properties
DeploymentResponse
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

camunda-deployments-api-openapi.yml Raw ↑

Other APIs Camunda publishes across the network.

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