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

The admin API from Windmill — 6 operation(s) for admin.

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

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

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

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

6 operations 6 paths 9 schemas 1 DELETE2 GET3 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 admin 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 6

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

admin 6
GET
/w/{workspace}/users/get/{username}
Get User (require Admin Privilege)
getUser 2 params → 200
POST
/w/{workspace}/users/update/{username}
Update User (require Admin Privilege)
updateUser 2 params body → 200
DELETE
/w/{workspace}/users/delete/{username}
Delete User (require Admin Privilege)
deleteUser 2 params → 200
GET
/w/{workspace}/users/offboard_preview/{username}
Preview Offboarding for a Workspace User (require Admin Privilege)
offboardPreview 2 params → 200
POST
/w/{workspace}/users/offboard/{username}
Offboard a Workspace User (reassign Objects, Optionally Delete User)
offboardWorkspaceUser 2 params body → 200
POST
/w/{workspace}/users/convert_to_group/{username}
Convert Manual User to Group User (require Admin Privilege)
convertUserToGroup 2 params → 200

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are User (13 properties), OffboardSummary (8 properties), OffboardAffectedPaths (7 properties), OffboardPreview (6 properties). Each schema is shown below with its type and property counts.

OffboardPreview
object
6 properties 6 required
EditWorkspaceUser
object
3 properties
OffboardResponse
object
2 properties
OffboardAffectedPaths
object
7 properties
UserSource
object
3 properties 1 required
OffboardTokenInfo
object
3 properties 2 required
User
object
13 properties 9 required
OffboardRequest
object
3 properties 1 required
OffboardSummary
object
8 properties 8 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

windmill-admin-api-openapi.yml Raw ↑

Other APIs Windmill publishes across the network.

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
Windmill favorite API