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

User groups for role-based access control.

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

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

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

Requests are made against 2 base URLs: https://app.windmill.dev/api, http://localhost:8000/api.

3 operations 3 paths 2 schemas 1 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 2

Windmill Groups 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.

  • bearerAuth — Bearer token created in the Windmill UI under account settings, passed as Authorization: Bearer YOURTOKEN.
  • cookieAuth — Session cookie set by the Windmill web UI after login.

Paths & Operations 3

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

Groups 3

User groups for role-based access control.

GET
/w/{workspace}/groups/list
List groups
listGroups 1 param → 200401
POST
/w/{workspace}/groups/create
Create a group
createGroup 1 param body → 201401
POST
/w/{workspace}/groups/adduser/{name}
Add a user to a group
addUserToGroup 2 params body → 200404

Schemas 2

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

Group
object
3 properties 1 required
Error
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

windmill-dev-groups-api-openapi.yml Raw ↑

Other APIs Windmill publishes across the network.

Windmill Apps API
Windmill Audit API
Windmill Flows API
Windmill Folders API
Windmill Jobs API
Windmill OIDC API
Windmill Resources API
Windmill Schedules API
Windmill Scripts API
Windmill Triggers API
Windmill Users API
Windmill Variables API