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

The variable API from Windmill — 10 operation(s) for variable.

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

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

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

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

10 operations 10 paths 4 schemas 2 DELETE5 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 variable 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 10

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

variable 10
POST
/w/{workspace}/variables/create
Create Variable
createVariable 2 params body → 201
POST
/w/{workspace}/variables/encrypt
Encrypt Value
encryptValue 1 param body → 200
DELETE
/w/{workspace}/variables/delete/{path}
Delete Variable
deleteVariable 2 params → 200
DELETE
/w/{workspace}/variables/delete_bulk
Delete Variables in Bulk
deleteVariablesBulk 1 param body → 200
POST
/w/{workspace}/variables/update/{path}
Update Variable
updateVariable 3 params body → 200
GET
/w/{workspace}/variables/get/{path}
Get Variable
getVariable 4 params → 200
GET
/w/{workspace}/variables/get_value/{path}
Get Variable Value
getVariableValue 3 params → 200
GET
/w/{workspace}/variables/exists/{path}
Does Variable Exists at Path
existsVariable 2 params → 200
GET
/w/{workspace}/variables/list
List Variables
listVariable 9 params → 200
GET
/w/{workspace}/variables/list_contextual
List Contextual Variables
listContextualVariables 1 param → 200

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are ListableVariable (14 properties), CreateVariable (8 properties), EditVariable (5 properties), ContextualVariable (4 properties). Each schema is shown below with its type and property counts.

EditVariable
object
5 properties
ContextualVariable
object
4 properties 4 required
CreateVariable
object
8 properties 4 required
ListableVariable
object
14 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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