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

The worker API from Windmill — 9 operation(s) for worker.

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

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

This API exposes 9 operations across 9 paths, and defines 1 schema. It is described by OpenAPI 3.0.3, at version 1.694.0.

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

9 operations 9 paths 1 schemas 9 GET

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 worker 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 9

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

worker 9
GET
/workers/custom_tags
Get All Instance Custom Tags (tags are Used to Dispatch Jobs to different worker groups)
getCustomTags 1 param → 200
GET
/w/{workspace}/workers/custom_tags
Get Custom Tags Available for this Workspace
getCustomTagsForWorkspace 1 param → 200
GET
/workers/get_default_tags
Get All Instance Default Tags
geDefaultTags → 200
GET
/workers/is_default_tags_per_workspace
Is Default Tags Per Workspace
isDefaultTagsPerWorkspace → 200
GET
/workers/list
List Workers
listWorkers 3 params → 200
GET
/workers/exists_workers_with_tags
Exists Workers with Tags
existsWorkersWithTags 2 params → 200
GET
/workers/queue_metrics
Get Queue Metrics
getQueueMetrics → 200
GET
/workers/queue_counts
Get Counts of Jobs Waiting for an Executor Per Tag
getCountsOfJobsWaitingPerTag → 200
GET
/workers/queue_running_counts
Get Counts of Currently Running Jobs Per Tag
getCountsOfRunningJobsPerTag → 200

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is WorkerPing (21 properties). Each schema is shown below with its type and property counts.

WorkerPing
object
21 properties 8 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

windmill-worker-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