/
WI
windmill
/
Windmill API
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Checked 1h ago · Updated 6h ago
5f7e0c3a8f59
OpenAPI 3.0.3
Apache 2.0
raw.githubusercontent.com
2026-08-14
824
353
1000.1 KB
agent_workers
5
post
create agent token
post
blacklist agent token (requires super admin)
post
remove agent token from blacklist (requires super admin)
get
list blacklisted agent tokens (requires super admin)
get
get minimum worker version across all workers
amqp_trigger
8
post
create amqp trigger
post
update amqp trigger
delete
delete amqp trigger
get
get amqp trigger
get
list amqp triggers
get
does amqp trigger exists
post
set enabled amqp trigger
post
test amqp connection
app
41
get
list all hub apps
get
get hub app by id
get
get hub raw app by id
get
get public app by custom path
get
get app embed token by custom path
get
get raw app data by
get
list apps for search
get
list all apps
post
create app
post
create app raw
get
does an app exisst at path
get
get app by path
post
mint a frontend SDK token for the raw app editor's preview
get
get app embed token by path
get
get app lite by path
get
get app history by path
get
get apps's latest version
get
list app paths from workspace runnable
post
update app history
get
get public app by secret
get
get app embed token by secret
get
get public resource
get
get public secret of app
get
get public secret of latest version of an app bundle
get
get app by version
delete
delete app
post
update app
post
create a raw app from its sources, compiling them on a worker (which runs the app's own dependencies to do so)
post
update a raw app from its sources, compiling them on a worker (which runs the app's own dependencies to do so)
post
update app
get
check if custom path exists
post
sign s3 objects (caller must have S3 read permission on each key); the signed URLs can then be used by anonymous users in public apps
post
executeComponent
post
upload s3 file from app
delete
delete s3 file from app
get
Load metadata of an s3 file on-behalf of the app author (deployed app)
get
Load a preview of an s3 file on-behalf of the app author (deployed app)
get
Load a preview of a parquet file on-behalf of the app author (deployed app)
get
Load a preview of a csv file on-behalf of the app author (deployed app)
get
Load the table row count on-behalf of the app author (deployed app)
get
Download a parquet s3 file as csv on-behalf of the app author (deployed app)
asset
9
get
List all assets in the workspace with cursor pagination
post
List all assets used by given usages paths
get
List all favorite assets for the authenticated user
get
Get the workspace-wide asset <-> runnable graph
get
List every workspace DuckDB macro (deployed `// macros` libraries)
get
List folders that contain at least one pipeline-member script
get
List materialized partitions for a ducklake asset
get
List expected partitions of a ducklake asset in a date range with their materialization status (enterprise)
get
List captured output-schema versions for a ducklake asset
audit
2
get
get audit log (requires admin privilege)
get
list audit logs (requires admin privilege)
azure_trigger
13
post
create an Azure Event Grid trigger
post
update an Azure Event Grid trigger
delete
delete an Azure Event Grid trigger
get
get an Azure Event Grid trigger
get
list azure triggers
get
check whether an azure trigger exists
post
set azure trigger mode
post
test Azure service principal connection
post
list topics under an Event Grid Namespace
post
list subscriptions under a Namespace topic
delete
delete an Event Grid subscription on Azure
post
list Event Grid Namespaces the service principal can access
post
list Basic Event Grid topics + system topics the service principal can access
capture
7
post
set capture config
post
ping capture config
get
get capture configs for a script or flow
get
list captures for a script or flow
post
move captures and configs for a script or flow
get
get a capture
delete
delete a capture
concurrencyGroups
4
get
List all concurrency groups
delete
Delete concurrency group
get
Get the concurrency key for a job that has concurrency limits enabled
get
Get intervals of job runtime concurrency
config
10
get
list worker groups
get
get config
post
Update config
delete
Delete Config
get
list configs
get
List autoscaling events
get
Check Kubernetes autoscaling health for a worker group
get
Get currently available python versions provided by UV.
get
list all workspace dependencies
get
list all dedicated scripts with their dependencies
data_metric
1
get
list declared measures and dimensions on DuckLake tables
dbt
3
post
record the running job's settled dbt nodes
get
resolve a dbt warehouse to the connection it names
get
check that a dbt warehouse is configured, without resolving it
documentation
2
get
Full-text search across the entire Windmill documentation. Provide one or more keywords; returns the most relevant docs pages, each with its Source URL and short matching snippets. Use this FIRST to find relevant pages by their content (a flag, function, error message, config key or concept). If the snippets answer the question, answer directly; otherwise call readDocsPage with a returned Source URL to read more.
get
Fetch the markdown of a single Windmill documentation page. Provide the `url` of a page found via searchDocs (its Source URL). If the page is large, this returns its list of section headings instead of the full content; call again with the `section` argument set to one of those headings to read that section.
draft
5
get
list every draft the current user has in this workspace, across all kinds
get
fetch a single draft's content by workspace username (or the legacy workspace-level row)
get
fetch the current user's own draft content at a path (any kind)
post
upsert (or clear) the current user's draft at a path
post
resolve a legacy (workspace-level) draft (admin only)
email_trigger
8
post
create email trigger
post
update email trigger
delete
delete email trigger
get
get email trigger
get
list email triggers
get
does email trigger exists
post
does email local part exists
post
enable/disable email trigger
favorite
2
post
star item
post
unstar item
flow
20
get
list all hub flows
get
get hub flow by id
get
list all flow paths
get
list flows for search
get
list all flows
get
get flow history by path
get
get flow's latest version
get
list flow paths from workspace runnable
get
get flow version
post
update flow history
get
get flow by path
get
get flow deployment status
get
get triggers count of flow
get
get tokens with flow scope
post
Toggle ON and OFF the workspace error handler for a given flow
get
exists flow by path
post
create flow
post
update flow
post
archive flow by path
delete
delete flow by path
flow_conversations
3
get
list flow conversations
delete
delete flow conversation
get
list conversation messages
folder
11
get
list folders
get
list folder names
post
create folder
post
update folder
delete
delete folder
get
get folder
get
exists folder
get
get folder usage
post
add owner to folder
post
remove owner to folder
get
get folder permission history
gcp_trigger
11
post
create gcp trigger
post
update gcp trigger
delete
delete gcp trigger
get
get gcp trigger
get
list gcp triggers
get
does gcp trigger exists
post
set enabled gcp trigger
post
test gcp connection
delete
delete gcp trigger
get
list all topics of google cloud service
post
list all subscription of a give topic from google cloud service
Git Sync
10
get
get connected repositories
post
Install a GitHub installation from another workspace
delete
Delete a GitHub installation from a workspace
get
Export GitHub installation JWT token
post
Import GitHub installation from JWT token
post
GHES installation callback
get
Get GHES app config
get
Discover GHES App installations
post
Assign GHES installation to a workspace
delete
Unassign GHES installation from a workspace
granular_acl
3
get
get granular acls
post
add granular acls
post
remove granular acls
group
19
get
list instance groups
get
list instance groups with workspace information
get
get instance group
post
create instance group
post
update instance group
delete
delete instance group
post
add user to instance group
post
remove user from instance group
get
export instance groups
post
overwrite instance groups
get
list groups
get
list group names
post
create group
post
update group
delete
delete group
get
get group
post
add user to group
post
remove user to group
get
get group permission history
health
2
get
health status
get
detailed health status
helpers
24
post
Converts an S3 resource to the set of instructions necessary to connect DuckDB to an S3 bucket
post
Converts an S3 resource to the set of instructions necessary to connect DuckDB to an S3 bucket
post
Converts an S3 resource to the set of arguments necessary to connect Polars to an S3 bucket
post
Converts an S3 resource to the set of arguments necessary to connect Polars to an S3 bucket
post
Returns the s3 resource associated to the provided path, or the workspace default S3 resource
get
Test connection to the workspace object storage
get
Get the storage usage of the workspace object storage, per configured storage. On Community Edition, also returns the workspace storage quota.
get
List the file keys available in a workspace object storage
get
List one page of a single folder level in a workspace object storage
get
Load metadata of the file
get
Load a preview of the file
get
List the file keys available in instance object storage with resource-based access control
get
Load a preview of a file from instance storage with resource-based access control
get
Load file metadata from instance storage with resource-based access control
get
Check if S3 path exists and is a folder
get
Load a preview of a parquet file
get
Load the table row count
get
Load a preview of a csv file
delete
Permanently delete file from S3
get
Move a S3 file from one path to the other within the same bucket
post
Upload file to S3 bucket
post
Upload a file to the instance storage gitrepos section for viewing
get
Download file from S3 bucket
get
Download file to S3 bucket
http_trigger
9
post
create many HTTP triggers
post
create http trigger
post
update http trigger
delete
delete http trigger
get
get http trigger
get
list http triggers
get
does http trigger exists
post
does route exists
post
enable/disable http trigger
hubPublish
17
post
create or update a hub project draft
post
publish a script to a hub project
post
publish a flow to a hub project
post
publish an app to a hub project
post
publish a raw app to a hub project
post
attach a recorded session to a hub raw app
post
attach a recording to a hub script
post
attach a recording to a hub flow
post
attach a data-pipeline recording to a hub project
post
publish a resource type to a hub project
post
publish resource placeholders to a hub project
post
publish triggers to a hub project
post
publish data table migrations to a hub project
get
export a hub project
post
set or clear a hub project's custom logo
post
submit a hub project draft for review
get
get the hub project linked to a workspace folder
indexSearch
7
get
Search through jobs with a string query
get
Search through service logs with a string query
get
Search and count the log line hits on every provided host
get
Get index disk storage sizes from the indexer.
delete
Clear an index and restart the indexer.
get
Get index storage sizes (disk and S3).
get
Get indexer status including liveness and storage sizes.
input
6
get
List Inputs used in previously completed jobs
get
Get args from history or saved input
get
List saved Inputs for a Runnable
post
Create an Input for future use in a script or flow
post
Update an Input
post
Delete a Saved Input
integration
1
get
list hub integrations
job
98
post
list selected jobs script/flow schemas grouped by (kind, path)
post
run script by path
get
run script by path with get
post
run script by path
post
run flow by path and wait until completion
get
run flow by version with GET and wait until completion
post
run flow by version and wait until completion
get
run flow by path with GET and stream updates via SSE
post
run flow by path and stream updates via SSE
get
run flow by version with GET and stream updates via SSE
post
run flow by version and stream updates via SSE
get
run script by path with GET and stream updates via SSE
post
run script by path and stream updates via SSE
get
run script by hash with GET and stream updates via SSE
post
run script by hash and stream updates via SSE
get
get job result by id
get
mint a read-only share token for a job
get
mint a public read-only share token for a job
post
run flow by path
post
run flow by version
post
re-run multiple jobs
post
restart a completed flow at a given step
post
run script by hash
post
run script preview
post
run script preview without starting a new job
post
run script by path without starting a new job
post
run script by hash without starting a new job
post
run script preview and wait for result
post
run code-workflow task
post
run a one-off dependencies job
post
queue a one-off dependencies job and return the job uuid
post
queue a one-off flow dependencies job and return the job uuid
post
run flow preview
post
run flow preview and wait for result
post
run dynamic select helper function
get
list all queued jobs
get
get queue count
get
get completed count
get
count number of completed jobs with filter
get
get the ids of all jobs matching the given filters
get
get the ids of all queued jobs matching the given filters
post
cancel jobs based on the given uuids
get
get OpenTelemetry traces for a job
get
list all completed jobs
get
export all completed jobs for backup/migration
post
import completed jobs from backup/migration
get
export all queued jobs for backup/migration
post
import queued jobs from backup/migration
post
delete jobs by IDs from all related tables
get
list all jobs
get
get db clock
get
Count jobs by tag
get
get job
get
get root job id
get
get job logs
get
get all logs for a flow job
get
get all logs for a flow job in a structured format
get
get statuses and truncated results for all jobs of a flow job's execution tree
get
get completed job logs tail
get
get job args
post
get started at by ids
get
get job updates
get
get job updates via server-sent events
get
get log file from object store
get
get flow debug info
get
get completed job
get
get completed job result
get
get completed job result if job is completed
get
get completed job timing
get
list asset-trigger dispatch events for a producer job
get
list asset-cascade producer→child job edges for a folder
post
delete completed job (erase content but keep run id)
post
mark failed jobs as resolved
post
remove the resolution of failed jobs
post
cancel queued or running job
post
cancel all queued jobs for persistent script
post
force cancel queued job
get
get queue position for a job
get
get scheduled for timestamp for a job
get
create an HMac signature given a job id and a resume id
get
get resume urls given a job_id, resume_id and a nonce to resume a flow
get
get the resume urls bound to a specific wait_for_approval step of a workflow-as-code job
get
generate interactive slack approval for suspended job
get
generate interactive teams approval for suspended job
post
resume or cancel a suspended flow/WAC job
get
get approval info for a suspended flow/WAC job
get
resume a job for a suspended flow
post
resume a job for a suspended flow
get
get flow user state at a given key
post
set flow user state at a given key
post
resume a job for a suspended flow as an owner
get
cancel a job for a suspended flow
post
cancel a job for a suspended flow
get
get parent flow job of suspended job
get
Whether a dbt retry by this caller would resume this run
get
Which run a dbt retry of this script would resume for the caller
get
Get the asset graph as one run saw it
get
List the per-relation progress one job has recorded so far
kafka_trigger
10
post
create kafka trigger
post
update kafka trigger
delete
delete kafka trigger
get
get kafka trigger
get
list kafka triggers
get
does kafka trigger exists
post
set enabled kafka trigger
post
test kafka connection
post
reset kafka trigger offsets to earliest
post
commit kafka offsets for a specific trigger
mcp
1
get
list available MCP tools
mcp_oauth
3
post
discover MCP server OAuth metadata
get
start MCP OAuth popup flow
get
MCP OAuth callback
metrics
3
post
get job metrics
post
set job metrics
get
get job progress
mqtt_trigger
8
post
create mqtt trigger
post
update mqtt trigger
delete
delete mqtt trigger
get
get mqtt trigger
get
list mqtt triggers
get
does mqtt trigger exists
post
set enabled mqtt trigger
post
test mqtt connection
native_trigger
13
post
create native trigger
post
update native trigger
get
get native trigger
delete
delete native trigger
get
list native triggers
get
check if native trigger exists
post
sync native triggers with external service
get
list available NextCloud events
get
list Google Calendars for the authenticated user
get
list or search Google Drive files
get
list shared drives accessible to the user
get
list GitHub repositories accessible to the user
post
receive webhook from external native trigger service
nats_trigger
8
post
create nats trigger
post
update nats trigger
delete
delete nats trigger
get
get nats trigger
get
list nats triggers
get
does nats trigger exists
post
set enabled nats trigger
post
test NATS connection
npm_proxy
6
get
get npm proxy configuration
get
get npm package metadata from private registry
get
resolve npm package version from private registry
get
get npm package file tree from private registry
get
get specific file from npm package in private registry
get
get npm package tarball from private registry
oauth
13
post
connect slack callback
post
connect slack callback instance
post
connect slack instance (non-interactive; pre-minted bot token)
post
connect callback
post
create OAuth account
post
connect OAuth using client credentials
post
refresh token
post
disconnect account
post
disconnect slack
post
disconnect teams
get
list oauth logins
get
list oauth connects
get
get oauth connect
oidc
1
post
get OIDC token (ee only)
openapi
2
post
generate openapi spec from http routes/webhook
post
Download the OpenAPI v3.1 spec as a file
path_autocomplete
1
get
list all paths in a workspace for client-side autocomplete
postgres_trigger
20
get
get postgres version
get
check if postgres configuration is set to logical
post
create template script
get
get template script
get
list postgres replication slot
post
create replication slot for postgres
delete
delete postgres replication slot
get
list postgres publication
get
get postgres publication
post
create publication for postgres
post
update publication for postgres
delete
delete postgres publication
post
create postgres trigger
post
update postgres trigger
delete
delete postgres trigger
get
get postgres trigger
get
list postgres triggers
get
does postgres trigger exists
post
set enabled postgres trigger
post
test postgres connection
raw_app
1
get
list all raw apps
resource
27
post
create resource
delete
delete resource
delete
delete resources in bulk
post
update resource
post
update resource value
get
get resource version history
delete
clear a resource's past versions, keeping only the current value
get
get a single resource version, with its value
post
restore a resource to a previous version
get
get resource
get
get resource interpolated (variables and resources are fully unrolled)
get
get resource value
get
get git repository latest commit hash
get
does resource exists
get
list resources
get
list resources for search
get
get MCP tools from resource
get
list resource names
post
create resource_type
get
get map from resource type to format extension
delete
delete resource_type
post
update resource_type
get
get resource_type
get
does resource_type exists
get
list resource_types
get
list resource_types names
get
query resource types by similarity
schedule
10
post
preview schedule
post
create schedule
post
update schedule
post
set enabled schedule
delete
delete schedule
get
get schedule
get
does schedule exists
get
list schedules
get
list schedules with last 20 jobs
post
Set default error or recoevery handler
script
36
get
get hub script content by path
get
get full hub script by path
get
record hub script pick
get
get top hub scripts
get
query hub scripts by similarity
get
list scripts for search
get
list all scripts
get
list all scripts paths
post
create script
post
Toggle ON and OFF the workspace error handler for a given script
post
archive script by path
post
archive script by hash
post
delete script by hash (erase content but keep hash, require admin)
post
delete script at a given path (require admin)
delete
delete scripts in bulk
get
get script by path
get
get triggers count of script
get
get tokens with script scope
get
get history of a script by path
get
list script paths using provided script as a relative import
get
get scripts's latest version (hash)
post
update history of a script
get
list dedicated worker scripts with workspace dependency annotations
get
raw script by path
get
raw script by path with a token (mostly used by lsp to be used with import maps to resolve scripts)
get
exists script by path
get
get script by hash
get
raw script by hash
get
get script deployment status
get
get CI test results for a script, flow, or resource
post
get CI test results for multiple items
post
check a script's asset references against captured producer schemas
post
store raw script content temporarily for CLI lock generation
post
diff local script hashes against deployed versions
get
list runnables (scripts, flows, apps) merged, ordered and keyset-paginated
get
count runnables per owner (folder or user space)
service_logs
2
get
list log files ordered by timestamp
get
get log file by path
setting
52
post
Refreshes the passwords for the custom_instance_user and the custom_instance_replication_user (used by postgres triggers)
post
Returns the set-up statuses of custom instance pg databases
post
Runs CREATE DATABASE on the Windmill Postgres and grants access to the custom_instance_user
post
Drops a custom instance database (superadmin only, irreversible)
get
get global settings
post
post global settings
get
get instance ruff config (unauthenticated)
get
get local settings
post
test smtp
post
test critical channels
get
Get all critical alerts
post
Acknowledge a critical alert
post
Acknowledge all unacknowledged critical alerts
post
test license key
post
test object storage config
get
get current or last object storage usage computation (null if never run)
post
start a background computation of object storage usage by top-level folder
post
start a manual cleanup of expired logs from object storage
get
get status of the manual log cleanup task
get
get status of the audit-log object-store export cursor
post
start an opt-in historical backfill of audit logs to object storage
get
get status of the audit-log object-store historical backfill
post
send stats
post
restart worker group
get
get telemetry stats with HMAC signature (EE only)
get
get latest key renewal attempt
post
renew license key
get
get cap-usage status for the currently-loaded offline license
get
per-instance binding hash for offline license issuance
post
create customer portal session
post
test metadata
get
list global settings
get
list git-sync repositories whose webhook still points at a previous receiver
get
get full instance config (global settings + worker configs)
put
update instance config (bulk upsert, no deletes). Empty or missing global_settings/worker_configs are skipped.
get
get minimum worker versions required to stay alive
get
get JWKS for Vault JWT authentication
post
test secret backend connection (HashiCorp Vault)
post
migrate secrets from database to HashiCorp Vault
post
migrate secrets from HashiCorp Vault to database
post
test Azure Key Vault connection
post
migrate secrets from database to Azure Key Vault
post
migrate secrets from Azure Key Vault to database
post
test connection to AWS Secrets Manager
post
migrate secrets from database to AWS Secrets Manager
post
migrate secrets from AWS Secrets Manager to database
get
get secondary storage names
get
Get all critical alerts for this workspace
post
Acknowledge a critical alert for this workspace
post
Acknowledge all unacknowledged critical alerts for this workspace
post
Mute critical alert UI for this workspace
post
Set public app rate limit for this workspace
settings
4
get
get backend version
get
is backend up to date
get
get license id
get
get openapi yaml spec
sqs_trigger
8
post
create sqs trigger
post
update sqs trigger
delete
delete sqs trigger
get
get sqs trigger
get
list sqs triggers
get
does sqs trigger exists
post
set enabled sqs trigger
post
test sqs connection
teams
1
post
send update to Microsoft Teams activity
token
1
get
list of available scopes
trigger
2
post
resume all suspended jobs for a specific trigger
post
cancel all suspended jobs for a specific trigger
user
57
post
login with password
post
logout
get
check if SMTP is configured for password reset
get
check if password login is disabled instance-wide
post
request password reset email
post
reset password using token
get
get user (require admin privilege)
post
update user (require admin privilege)
get
is owner of path
post
set password
post
set password for a specific user (require super admin)
post
set login type for a specific user (require super admin)
post
create user
post
global update user (require super admin)
get
global username info (require super admin)
post
global rename user (require super admin)
post
global change user email (require super admin)
delete
global delete user (require super admin)
post
global overwrite users (require super admin and EE)
get
global export users (require super admin and EE)
get
list external JWT tokens (ee only)
post
Submit user onboarding data
delete
delete user (require admin privilege, except for the creator of a fork removing a non-admin member of the fork)
get
preview offboarding for a workspace user (require admin privilege)
post
offboard a workspace user (reassign objects, optionally delete user)
get
preview global offboarding for a user across all workspaces (require super admin)
post
offboard a user globally (reassign objects across workspaces, optionally delete)
post
convert manual user to group user (require admin privilege)
get
get current user email (if logged in)
get
refresh the current token
get
get tutorial progress
post
update tutorial progress
post
leave instance
get
get current usage outside of premium workspaces
get
get all runnables in every workspace
get
get current global whoami (if logged in)
get
list all workspace invites
get
whoami
post
accept invite to workspace
post
decline invite to workspace
post
impersonate a service account
post
exit service account impersonation
get
whois
get
exists email
get
list all users as super admin (require to be super amdin)
get
list users
get
list instance users that can still be added to this workspace (require to be super admin)
get
list users usage
get
list usernames
get
get email from username
post
create token
post
create token to impersonate a user (require superadmin)
delete
delete token
post
update scopes of an existing token (owner only)
post
update label of an existing token (owner only)
get
list token
post
login with oauth authorization flow
variable
10
post
create variable
post
encrypt value
delete
delete variable
delete
delete variables in bulk
post
update variable
get
get variable
get
get variable value
get
does variable exists at path
get
list variables
get
list contextual variables
volume
4
get
List all volumes in the workspace
get
Get the volume storage name (secondary storage) or null for primary
post
Create a new volume
delete
Delete a volume (admin only)
websocket_trigger
8
post
create websocket trigger
post
update websocket trigger
delete
delete websocket trigger
get
get websocket trigger
get
list websocket triggers
get
does websocket trigger exists
post
set enabled websocket trigger
post
test websocket connection
worker
10
get
get all instance custom tags (tags are used to dispatch jobs to different worker groups)
get
get custom tags available for this workspace
get
get all instance default tags
get
is default tags per workspace
get
list workers
get
exists workers with tags
get
get queue metrics
get
get counts of jobs waiting for an executor per tag
get
get counts of currently running jobs per tag
get
list last 100 workspace-fairness cap/uncap events (cloud-only)
workspace
128
get
list all workspaces visible to me
get
is domain allowed for auto invi
get
list all workspaces visible to me with user info
post
get the lifecycle status of workspaces referenced by client-side sessions
get
get workspace as super admin (require to be super admin)
get
list all workspaces as super admin (require to be super admin)
post
create workspace
post
create forked workspace branch with git sync
post
create forked workspace
post
attach an existing workspace as the dev workspace of this (prod) workspace
post
detach the dev workspace from this (prod) workspace
get
this workspace's active canonical dev workspace, if any
post
exists workspace
post
exists username
post
get github app token
post
invite user to workspace
post
add user to workspace (require admin privilege, except for the creator of a fork adding a developer/admin of its parent workspace as a developer of the fork)
post
create a service account
post
delete user invite
post
archive workspace
post
unarchive workspace
delete
delete workspace (require super admin)
post
leave workspace
get
get workspace name
post
change workspace name
post
change workspace id
post
change workspace id
post
Update operator settings for a workspace
get
Compare two workspaces
post
Seed the diff candidate set against an arbitrary workspace
post
Resets the ahead and behind deployement counter after a deployement
get
list pending invites for a workspace
get
get public settings
get
get settings (admin only)
get
get the workspace this one deploys into (its fork parent)
get
get if workspace is premium
get
get premium info
get
get threshold alert info
post
set threshold alert info
post
rebuild dependency map
get
get dependents of an imported path
get
get script imports for an importer path
post
get dependents amounts for multiple imported paths
get
get dependency map
post
edit slack command
get
get workspace slack oauth config
post
set workspace slack oauth config
delete
delete workspace slack oauth config
post
edit teams command
get
list available teams ids
get
list available channels for a specific team
post
connect teams
post
connect slack (non-interactive; pre-minted bot token)
post
run a job that sends a message to Slack
post
run a job that sends a message to Teams
post
edit auto invite
post
edit instance groups
post
edit webhook
post
edit copilot config
get
get copilot settings state
get
get copilot info
post
edit error handler
post
edit success handler
post
edit large file storage settings
post
edit the workspace's dbt warehouses
get
list ducklakes
get
list Datatables
get
list schemas of all connected Datatables
get
check what the data table's database lets its role do
get
list tables of all connected Datatables
get
get one Datatable table schema
post
edit ducklake settings
post
edit datatable settings
post
run pending datatable migrations against a datatable
post
roll back the most recently applied migration on a datatable
get
list datatable migrations for a workspace
get
list a datatable's migrations with their applied status
post
opt a datatable in to migrations (admins / super admins only)
post
opt a datatable out of migrations, deleting all of them (admins / super admins only)
post
create a single datatable migration (version generated server-side)
delete
delete a single datatable migration definition
post
insert or update a single datatable migration at an explicit version
post
snapshot the current schema as an already-installed initial migration
post
create a new PostgreSQL database for a datatable
post
drop forked datatable databases
post
drop this fork workspace's ducklake namespaces (catalog metadata schemas + data files)
post
import a PostgreSQL database from source to target via pg_dump
post
export the schema of a PostgreSQL database
post
get the full schema of a datatable database as TableEditorValues
get
Check if git sync is available for this workspace
get
Get how local changes deploy to this workspace via git sync
post
edit workspace git sync settings
post
add or update individual git sync repository
delete
delete individual git sync repository
post
edit workspace deploy ui settings
post
edit default app for workspace
get
get default scripts for workspace
post
edit default scripts for workspace
post
set environment variable
get
retrieves the encryption key for this workspace
post
update the encryption key for this workspace
get
get default app for workspace
get
get usage
get
get used triggers
get
list all protection rules for a workspace
post
create a new protection rule
post
update an existing protection rule
delete
delete a protection rule
get
list users eligible to be deployment request assignees
get
get the currently open deployment request for this fork
post
create a new deployment request
post
cancel an open deployment request
post
close a deployment request after a successful merge
post
append a comment to an open deployment request
post
log anonymous feature usage telemetry events
get
get cloud quota usage and limits for workspace
post
prune old versions of scripts, flows, apps, or resources
get
list all workspace-specific items
get
list workspace ids that have a version of the given item
post
mark or unmark an item as workspace-specific
get
get the workspace shared UI folder (full content)
get
list paths/sizes of the workspace shared UI folder
get
get the current version of the workspace shared UI folder
put
replace the workspace shared UI folder (admin only)
get
list the workspace AI chat skills (name + description only)
get
get a workspace AI chat skill including its instructions
post
upsert workspace AI chat skills (admin only)
delete
delete a workspace AI chat skill (admin only)
workspace_dependencies
5
post
create workspace dependencies
post
archive workspace dependencies (require admin)
post
delete workspace dependencies (require admin)
get
list all workspace dependencies
get
get latest workspace dependencies by language and name
workspace_integration
8
get
list available native trigger services
get
check if integrations for a particular service exists
post
create native trigger service
post
generate connect url for native trigger service
get
check if instance-level credential sharing is available for a service
post
generate connect url using instance-level credentials
delete
delete native trigger service
post
native trigger service oauth callback
settings
get backend version
get
/version
Response
git version of backend