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

Windmill kafka_trigger API

The kafka_trigger API from Windmill — 10 operation(s) for kafka_trigger.

Windmill kafka_trigger API is one of 59 APIs that Windmill publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include kafka_trigger. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and authentication docs.

This API exposes 10 operations across 10 paths, and defines 6 schemas. It is described by OpenAPI 3.0.3, at version 1.694.0.

Requests are made against a single base URL, /api.

10 operations 10 paths 6 schemas 1 DELETE3 GET6 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.694.0
Base URL
https://app.windmill.dev/api
Authentication
HTTP Bearer, API Key
License
Resource Areas
1

Authentication & Security 2

Windmill kafka_trigger API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). An API key is passed in the cookie as token (cookieAuth). By default, every request must be authenticated.

Paths & Operations 10

Across 10 paths, the API surfaces 10 operations — 1 DELETE, 3 GET, 6 POST. Each is listed below with its method, path, parameters, and response codes.

kafka_trigger 10
POST
/w/{workspace}/kafka_triggers/create
Create Kafka Trigger
createKafkaTrigger 1 param body → 201
POST
/w/{workspace}/kafka_triggers/update/{path}
Update Kafka Trigger
updateKafkaTrigger 2 params body → 200
DELETE
/w/{workspace}/kafka_triggers/delete/{path}
Delete Kafka Trigger
deleteKafkaTrigger 2 params → 200
GET
/w/{workspace}/kafka_triggers/get/{path}
Get Kafka Trigger
getKafkaTrigger 2 params → 200
GET
/w/{workspace}/kafka_triggers/list
List Kafka Triggers
listKafkaTriggers 7 params → 200
GET
/w/{workspace}/kafka_triggers/exists/{path}
Does Kafka Trigger Exists
existsKafkaTrigger 2 params → 200
POST
/w/{workspace}/kafka_triggers/setmode/{path}
Set Enabled Kafka Trigger
setKafkaTriggerMode 2 params body → 200
POST
/w/{workspace}/kafka_triggers/test
Test Kafka Connection
testKafkaConnection 1 param body → 200
POST
/w/{workspace}/kafka_triggers/reset_offsets/{path}
Reset Kafka Trigger Offsets to Earliest
resetKafkaOffsets 2 params → 200
POST
/w/{workspace}/kafka_triggers/commit_offsets/{path}
Commit Kafka Offsets for a Specific Trigger
commitKafkaOffsets 2 params body → 200

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are NewKafkaTrigger (17 properties), EditKafkaTrigger (16 properties), KafkaTrigger (13 properties), TriggerExtraProperty (10 properties). Each schema is shown below with its type and property counts.

NewKafkaTrigger
object
17 properties 7 required
TriggerExtraProperty
object
10 properties 9 required
KafkaTrigger
object
13 properties 4 required
ScriptArgs
object
The arguments to pass to the script or flow
EditKafkaTrigger
object
16 properties 7 required
TriggerMode
string
job trigger mode

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

windmill-kafka-trigger-api-openapi.yml Raw ↑

Other APIs Windmill publishes across the network.

Windmill admin API
Windmill agent_workers API
Windmill app API
Windmill asset API
Windmill audit API
Windmill azure_trigger API
Windmill capture API
Windmill concurrencyGroups API
Windmill config API
Windmill documentation API
Windmill draft API
Windmill email_trigger API