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

The group API from Windmill — 19 operation(s) for group.

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

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

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

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

19 operations 19 paths 5 schemas 2 DELETE8 GET9 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 group 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 19

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

group 19
GET
/groups/list
List Instance Groups
listInstanceGroups → 200
GET
/groups/list_with_workspaces
List Instance Groups with Workspace Information
listInstanceGroupsWithWorkspaces → 200
GET
/groups/get/{name}
Get Instance Group
getInstanceGroup 1 param → 200
POST
/groups/create
Create Instance Group
createInstanceGroup body → 200
POST
/groups/update/{name}
Update Instance Group
updateInstanceGroup 1 param body → 200
DELETE
/groups/delete/{name}
Delete Instance Group
deleteInstanceGroup 1 param → 200
POST
/groups/adduser/{name}
Add User to Instance Group
addUserToInstanceGroup 1 param body → 200
POST
/groups/removeuser/{name}
Remove User from Instance Group
removeUserFromInstanceGroup 1 param body → 200
GET
/groups/export
Export Instance Groups
exportInstanceGroups → 200
POST
/groups/overwrite
Overwrite Instance Groups
overwriteInstanceGroups body → 200
GET
/w/{workspace}/groups/list
List Groups
listGroups 3 params → 200
GET
/w/{workspace}/groups/listnames
List Group Names
listGroupNames 2 params → 200
POST
/w/{workspace}/groups/create
Create Group
createGroup 1 param body → 200
POST
/w/{workspace}/groups/update/{name}
Update Group
updateGroup 2 params body → 200
DELETE
/w/{workspace}/groups/delete/{name}
Delete Group
deleteGroup 2 params → 200
GET
/w/{workspace}/groups/get/{name}
Get Group
getGroup 2 params → 200
POST
/w/{workspace}/groups/adduser/{name}
Add User to Group
addUserToGroup 2 params body → 200
POST
/w/{workspace}/groups/removeuser/{name}
Remove User to Group
removeUserToGroup 2 params body → 200
GET
/w/{workspace}/groups_history/get/{name}
Get Group Permission History
getGroupPermissionHistory 4 params → 200

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are ExportedInstanceGroup (7 properties), InstanceGroupWithWorkspaces (5 properties), Group (4 properties), InstanceGroup (4 properties). Each schema is shown below with its type and property counts.

InstanceGroupWithWorkspaces
object
5 properties 1 required
InstanceGroup
object
4 properties 1 required
WorkspaceInfo
object
3 properties 1 required
Group
object
4 properties 1 required
ExportedInstanceGroup
object
7 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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