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

The resource API from Windmill — 23 operation(s) for resource.

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

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

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

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

23 operations 23 paths 6 schemas 3 DELETE15 GET5 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 resource 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 23

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

resource 23
POST
/w/{workspace}/resources/create
Create Resource
createResource 2 params body → 201
DELETE
/w/{workspace}/resources/delete/{path}
Delete Resource
deleteResource 2 params → 200
DELETE
/w/{workspace}/resources/delete_bulk
Delete Resources in Bulk
deleteResourcesBulk 1 param body → 200
POST
/w/{workspace}/resources/update/{path}
Update Resource
updateResource 2 params body → 200
POST
/w/{workspace}/resources/update_value/{path}
Update Resource Value
updateResourceValue 2 params body → 200
GET
/w/{workspace}/resources/get/{path}
Get Resource
getResource 2 params → 200
GET
/w/{workspace}/resources/get_value_interpolated/{path}
Get Resource Interpolated (variables and Resources are Fully Unrolled)
getResourceValueInterpolated 4 params → 200
GET
/w/{workspace}/resources/get_value/{path}
Get Resource Value
getResourceValue 2 params → 200
GET
/w/{workspace}/resources/git_commit_hash/{path}
Get Git Repository Latest Commit Hash
getGitCommitHash 3 params → 200
GET
/w/{workspace}/resources/exists/{path}
Does Resource Exists
existsResource 2 params → 200
GET
/w/{workspace}/resources/list
List Resources
listResource 11 params → 200
GET
/w/{workspace}/resources/list_search
List Resources for Search
listSearchResource 1 param → 200
GET
/w/{workspace}/resources/mcp_tools/{path}
Get MCP Tools from Resource
getMcpTools 2 params → 200
GET
/w/{workspace}/resources/list_names/{name}
List Resource Names
listResourceNames 2 params → 200
POST
/w/{workspace}/resources/type/create
Create Resourcetype
createResourceType 1 param body → 201
GET
/w/{workspace}/resources/file_resource_type_to_file_ext_map
Get Map from Resource Type to Format Extension
fileResourceTypeToFileExtMap 1 param → 200
DELETE
/w/{workspace}/resources/type/delete/{path}
Delete Resourcetype
deleteResourceType 2 params → 200
POST
/w/{workspace}/resources/type/update/{path}
Update Resourcetype
updateResourceType 2 params body → 200
GET
/w/{workspace}/resources/type/get/{path}
Get Resourcetype
getResourceType 2 params → 200
GET
/w/{workspace}/resources/type/exists/{path}
Does Resourcetype Exists
existsResourceType 2 params → 200
GET
/w/{workspace}/resources/type/list
List Resourcetypes
listResourceType 1 param → 200
GET
/w/{workspace}/resources/type/listnames
List Resourcetypes Names
listResourceTypeNames 1 param → 200
GET
/w/{workspace}/embeddings/query_resource_types
Query Resource Types by Similarity
queryResourceTypes 3 params → 200

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are ListableResource (15 properties), Resource (10 properties), ResourceType (8 properties), EditResource (5 properties). Each schema is shown below with its type and property counts.

Resource
object
10 properties 3 required
EditResourceType
object
3 properties
CreateResource
object
5 properties 3 required
EditResource
object
5 properties
ResourceType
object
8 properties 1 required
ListableResource
object
15 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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