Windmill Job API
The job API from Windmill — 77 operation(s) for job.
Operations 86
POST
/w/{workspace}/jobs/list_selected_job_groups
List Selected Jobs Script/flow Schemas Grouped by (kind, Path)
#
POST
/w/{workspace}/jobs/run_wait_result/fv/{version}
Run Flow by Version and Wait Until Completion
#
GET
/w/{workspace}/jobs/run_wait_result/fv/{version}
Run Flow by Version with GET and Wait Until Completion
#
GET
/w/{workspace}/jobs/run_and_stream/f/{path}
Run Flow by Path with GET and Stream Updates via SSE
#
POST
/w/{workspace}/jobs/run_and_stream/fv/{version}
Run Flow by Version and Stream Updates via SSE
#
GET
/w/{workspace}/jobs/run_and_stream/fv/{version}
Run Flow by Version with GET and Stream Updates via SSE
#
GET
/w/{workspace}/jobs/run_and_stream/p/{path}
Run Script by Path with GET and Stream Updates via SSE
#
GET
/w/{workspace}/jobs/run_and_stream/h/{hash}
Run Script by Hash with GET and Stream Updates via SSE
#
POST
/w/{workspace}/jobs/run/dependencies_async
Queue a One-off Dependencies Job and Return the Job Uuid
#
POST
/w/{workspace}/jobs/run/flow_dependencies_async
Queue a One-off Flow Dependencies Job and Return the Job Uuid
#
GET
/w/{workspace}/jobs/queue/list_filtered_uuids
Get the Ids of All Queued Jobs Matching the Given Filters
#
GET
/w/{workspace}/jobs_u/completed/get_result_maybe/{id}
Get Completed Job Result if Job is Completed
#
POST
/w/{workspace}/jobs/completed/delete/{id}
Delete Completed Job (erase Content but Keep Run Id)
#
POST
/w/{workspace}/jobs_u/queue/cancel_persistent/{path}
Cancel All Queued Jobs for Persistent Script
#
GET
/w/{workspace}/jobs/job_signature/{id}/{resume_id}
Create an HMac Signature Given a Job Id and a Resume Id
#
GET
/w/{workspace}/jobs/resume_urls/{id}/{resume_id}
Get Resume Urls Given a Job_id, Resume_id and a Nonce to Resume a Flow
#
POST
/w/{workspace}/jobs_u/flow/resume_suspended/{job_id}
Resume or Cancel a Suspended Flow/WAC Job
#
GET
/w/{workspace}/jobs_u/flow/approval_info/{job_id}
Get Approval Info for a Suspended Flow/WAC Job
#
GET
/w/{workspace}/jobs_u/get_flow/{id}/{resume_id}/{signature}
Get Parent Flow Job of Suspended Job
#
Documentation
Documentation
https://www.windmill.dev/docs/intro
GettingStarted
https://www.windmill.dev/docs/getting_started/how_to_use_windmill
Authentication
https://www.windmill.dev/docs/core_concepts/authentification
Specifications
Other Resources
APIReferenceDocumentation
https://app.windmill.dev/openapi.html
HTTPRoutes
https://www.windmill.dev/docs/core_concepts/http_routing
CLI
https://www.windmill.dev/docs/advanced/cli
SelfHosting
https://www.windmill.dev/docs/advanced/self_host
TypeScriptSDK
https://www.windmill.dev/docs/advanced/clients/ts_client
PythonSDK
https://www.windmill.dev/docs/advanced/clients/python_client
SpectralRules
https://artifacts.apis.io/windmill/rules/windmill-api-rules.yml