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

The health API from Windmill — 2 operation(s) for health.

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

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

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

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

2 operations 2 paths 8 schemas 2 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 health 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 2

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

health 2
GET
/health/status
Health Status
getHealthStatus 1 param → 200503
GET
/health/detailed
Detailed Health Status
getHealthDetailed → 200503

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are WorkersHealth (5 properties), HealthChecks (4 properties), DetailedHealthResponse (4 properties), HealthStatusResponse (4 properties). Each schema is shown below with its type and property counts.

QueueHealth
object
Job queue status
2 properties 2 required
DetailedHealthResponse
object
Detailed health status response (always fresh, no caching)
4 properties 4 required
DatabaseHealth
object
Database health status
3 properties 3 required
PoolStats
object
Database connection pool statistics
3 properties 3 required
WorkersHealth
object
Workers health status
5 properties 5 required
HealthChecks
object
Detailed health checks
4 properties 2 required
ReadinessHealth
object
Server readiness status
1 property 1 required
HealthStatusResponse
object
Health status response (cached with 5s TTL)
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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