{ "opencollection": "1.0.0", "info": { "name": "Windmill API", "version": "1.694.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "settings", "type": "folder" }, "items": [ { "info": { "name": "Get Backend Version", "type": "http" }, "http": { "method": "GET", "url": "/api/version" }, "docs": "Get Backend Version" }, { "info": { "name": "Is Backend up to Date", "type": "http" }, "http": { "method": "GET", "url": "/api/uptodate" }, "docs": "Is Backend up to Date" }, { "info": { "name": "Get License Id", "type": "http" }, "http": { "method": "GET", "url": "/api/ee_license" }, "docs": "Get License Id" }, { "info": { "name": "Get Openapi Yaml Spec", "type": "http" }, "http": { "method": "GET", "url": "/api/openapi.yaml" }, "docs": "Get Openapi Yaml Spec" } ] }, { "info": { "name": "health", "type": "folder" }, "items": [ { "info": { "name": "Health Status", "type": "http" }, "http": { "method": "GET", "url": "/api/health/status", "params": [ { "name": "force", "value": "", "type": "query", "description": "Force a fresh check, bypassing the cache" } ] }, "docs": "Health status endpoint. Returns cached health status (database connectivity, worker count).\nCache TTL is fixed at 5 seconds. Use force=true query parameter to bypass cache.\nNote: This endpoint is intentionally different from Kubernetes probes to avoid confusion.\nFor k8s liveness/readiness probes, use /version endpoint.\n" }, { "info": { "name": "Detailed Health Status", "type": "http" }, "http": { "method": "GET", "url": "/api/health/detailed" }, "docs": "Returns detailed health information including database pool stats, worker details, and queue status.\nRequires authentication. Use for monitoring dashboards and debugging.\nThis endpoint always returns fresh data (no caching).\n" } ] }, { "info": { "name": "documentation", "type": "folder" }, "items": [ { "info": { "name": "Query Windmill AI Documentation Assistant (EE Only)", "type": "http" }, "http": { "method": "POST", "url": "/api/inkeep", "body": { "type": "json", "data": "{}" } }, "docs": "Query Windmill AI Documentation Assistant (EE Only)" } ] }, { "info": { "name": "audit", "type": "folder" }, "items": [ { "info": { "name": "Get Audit Log (requires Admin Privilege)", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/audit/get/:id", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get Audit Log (requires Admin Privilege)" }, { "info": { "name": "List Audit Logs (requires Admin Privilege)", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/audit/list", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query", "description": "which page to return (start at 1, default 1)" }, { "name": "per_page", "value": "", "type": "query", "description": "number of items to return for a given page (default 30, max 100)" }, { "name": "before", "value": "", "type": "query", "description": "filter on started before (inclusive) timestamp" }, { "name": "after", "value": "", "type": "query", "description": "filter on created after (exclusive) timestamp" }, { "name": "username", "value": "", "type": "query", "description": "filter on exact username of user" }, { "name": "operation", "value": "", "type": "query", "description": "filter on exact or prefix name of operation" }, { "name": "operations", "value": "", "type": "query", "description": "comma separated list of exact operations to include" }, { "name": "exclude_operations", "value": "", "type": "query", "description": "comma separated list of operations to exclude" }, { "name": "resource", "value": "", "type": "query", "description": "filter on exact or prefix name of resource" }, { "name": "action_kind", "value": "", "type": "query", "description": "filter on type of operation" }, { "name": "all_workspaces", "value": "", "type": "query", "description": "get audit logs for all workspaces" } ] }, "docs": "List Audit Logs (requires Admin Privilege)" } ] }, { "info": { "name": "user", "type": "folder" }, "items": [ { "info": { "name": "Login with Password", "type": "http" }, "http": { "method": "POST", "url": "/api/auth/login", "body": { "type": "json", "data": "{}" } }, "docs": "Login with Password" }, { "info": { "name": "Logout", "type": "http" }, "http": { "method": "POST", "url": "/api/auth/logout" }, "docs": "Logout" }, { "info": { "name": "Check if SMTP is Configured for Password Reset", "type": "http" }, "http": { "method": "GET", "url": "/api/auth/is_smtp_configured" }, "docs": "Check if SMTP is Configured for Password Reset" }, { "info": { "name": "Check if Password Login is Disabled Instance-wide", "type": "http" }, "http": { "method": "GET", "url": "/api/auth/is_password_login_disabled" }, "docs": "Check if Password Login is Disabled Instance-wide" }, { "info": { "name": "Request Password Reset Email", "type": "http" }, "http": { "method": "POST", "url": "/api/auth/request_password_reset", "body": { "type": "json", "data": "{}" } }, "docs": "Request Password Reset Email" }, { "info": { "name": "Reset Password Using Token", "type": "http" }, "http": { "method": "POST", "url": "/api/auth/reset_password", "body": { "type": "json", "data": "{}" } }, "docs": "Reset Password Using Token" }, { "info": { "name": "Get User (require Admin Privilege)", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/users/get/:username", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "username", "value": "", "type": "path" } ] }, "docs": "Get User (require Admin Privilege)" }, { "info": { "name": "Update User (require Admin Privilege)", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/users/update/:username", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "username", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update User (require Admin Privilege)" }, { "info": { "name": "Is Owner of Path", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/users/is_owner/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "Is Owner of Path" }, { "info": { "name": "Set Password", "type": "http" }, "http": { "method": "POST", "url": "/api/users/setpassword", "body": { "type": "json", "data": "{}" } }, "docs": "Set Password" }, { "info": { "name": "Set Password for a Specific User (require Super Admin)", "type": "http" }, "http": { "method": "POST", "url": "/api/users/set_password_of/:user", "params": [ { "name": "user", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Set Password for a Specific User (require Super Admin)" }, { "info": { "name": "Set Login Type for a Specific User (require Super Admin)", "type": "http" }, "http": { "method": "POST", "url": "/api/users/set_login_type/:user", "params": [ { "name": "user", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Set Login Type for a Specific User (require Super Admin)" }, { "info": { "name": "Create User", "type": "http" }, "http": { "method": "POST", "url": "/api/users/create", "body": { "type": "json", "data": "{}" } }, "docs": "Create User" }, { "info": { "name": "Global Update User (require Super Admin)", "type": "http" }, "http": { "method": "POST", "url": "/api/users/update/:email", "params": [ { "name": "email", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Global Update User (require Super Admin)" }, { "info": { "name": "Global Username Info (require Super Admin)", "type": "http" }, "http": { "method": "GET", "url": "/api/users/username_info/:email", "params": [ { "name": "email", "value": "", "type": "path" } ] }, "docs": "Global Username Info (require Super Admin)" }, { "info": { "name": "Global Rename User (require Super Admin)", "type": "http" }, "http": { "method": "POST", "url": "/api/users/rename/:email", "params": [ { "name": "email", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Global Rename User (require Super Admin)" }, { "info": { "name": "Global Delete User (require Super Admin)", "type": "http" }, "http": { "method": "DELETE", "url": "/api/users/delete/:email", "params": [ { "name": "email", "value": "", "type": "path" } ] }, "docs": "Global Delete User (require Super Admin)" }, { "info": { "name": "Global Overwrite Users (require Super Admin and EE)", "type": "http" }, "http": { "method": "POST", "url": "/api/users/overwrite", "body": { "type": "json", "data": "{}" } }, "docs": "Global Overwrite Users (require Super Admin and EE)" }, { "info": { "name": "Global Export Users (require Super Admin and EE)", "type": "http" }, "http": { "method": "GET", "url": "/api/users/export" }, "docs": "Global Export Users (require Super Admin and EE)" }, { "info": { "name": "List External JWT Tokens (ee Only)", "type": "http" }, "http": { "method": "GET", "url": "/api/users/ext_jwt_tokens", "params": [ { "name": "page", "value": "", "type": "query" }, { "name": "per_page", "value": "", "type": "query" }, { "name": "active_only", "value": "", "type": "query", "description": "only tokens used in the last 30 days" } ] }, "docs": "List External JWT Tokens (ee Only)" }, { "info": { "name": "Submit User Onboarding Data", "type": "http" }, "http": { "method": "POST", "url": "/api/users/onboarding", "body": { "type": "json", "data": "{}" } }, "docs": "Submit User Onboarding Data" }, { "info": { "name": "Delete User (require Admin Privilege)", "type": "http" }, "http": { "method": "DELETE", "url": "/api/w/:workspace/users/delete/:username", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "username", "value": "", "type": "path" } ] }, "docs": "Delete User (require Admin Privilege)" }, { "info": { "name": "Preview Offboarding for a Workspace User (require Admin Privilege)", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/users/offboard_preview/:username", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "username", "value": "", "type": "path" } ] }, "docs": "Preview Offboarding for a Workspace User (require Admin Privilege)" }, { "info": { "name": "Offboard a Workspace User (reassign Objects, Optionally Delete User)", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/users/offboard/:username", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "username", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Offboard a Workspace User (reassign Objects, Optionally Delete User)" }, { "info": { "name": "Preview Global Offboarding for a User Across All Workspaces (require Super Admin)", "type": "http" }, "http": { "method": "GET", "url": "/api/users/offboard_preview/:email", "params": [ { "name": "email", "value": "", "type": "path" } ] }, "docs": "Preview Global Offboarding for a User Across All Workspaces (require Super Admin)" }, { "info": { "name": "Offboard a User Globally (reassign Objects Across Workspaces, Optionally Delete)", "type": "http" }, "http": { "method": "POST", "url": "/api/users/offboard/:email", "params": [ { "name": "email", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Offboard a User Globally (reassign Objects Across Workspaces, Optionally Delete)" }, { "info": { "name": "Convert Manual User to Group User (require Admin Privilege)", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/users/convert_to_group/:username", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "username", "value": "", "type": "path" } ] }, "docs": "Convert Manual User to Group User (require Admin Privilege)" }, { "info": { "name": "Get Current User Email (if Logged In)", "type": "http" }, "http": { "method": "GET", "url": "/api/users/email" }, "docs": "Get Current User Email (if Logged In)" }, { "info": { "name": "Refresh the Current Token", "type": "http" }, "http": { "method": "GET", "url": "/api/users/refresh_token", "params": [ { "name": "if_expiring_in_less_than_s", "value": "", "type": "query" } ] }, "docs": "Refresh the Current Token" }, { "info": { "name": "Get Tutorial Progress", "type": "http" }, "http": { "method": "GET", "url": "/api/users/tutorial_progress" }, "docs": "Get Tutorial Progress" }, { "info": { "name": "Update Tutorial Progress", "type": "http" }, "http": { "method": "POST", "url": "/api/users/tutorial_progress", "body": { "type": "json", "data": "{}" } }, "docs": "Update Tutorial Progress" }, { "info": { "name": "Leave Instance", "type": "http" }, "http": { "method": "POST", "url": "/api/users/leave_instance" }, "docs": "Leave Instance" }, { "info": { "name": "Get Current Usage Outside of Premium Workspaces", "type": "http" }, "http": { "method": "GET", "url": "/api/users/usage" }, "docs": "Get Current Usage Outside of Premium Workspaces" }, { "info": { "name": "Get All Runnables in Every Workspace", "type": "http" }, "http": { "method": "GET", "url": "/api/users/all_runnables" }, "docs": "Get All Runnables in Every Workspace" }, { "info": { "name": "Get Current Global Whoami (if Logged In)", "type": "http" }, "http": { "method": "GET", "url": "/api/users/whoami" }, "docs": "Get Current Global Whoami (if Logged In)" }, { "info": { "name": "List All Workspace Invites", "type": "http" }, "http": { "method": "GET", "url": "/api/users/list_invites" }, "docs": "List All Workspace Invites" }, { "info": { "name": "Whoami", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/users/whoami", "params": [ { "name": "workspace", "value": "", "type": "path" } ] }, "docs": "Whoami" }, { "info": { "name": "Accept Invite to Workspace", "type": "http" }, "http": { "method": "POST", "url": "/api/users/accept_invite", "body": { "type": "json", "data": "{}" } }, "docs": "Accept Invite to Workspace" }, { "info": { "name": "Decline Invite to Workspace", "type": "http" }, "http": { "method": "POST", "url": "/api/users/decline_invite", "body": { "type": "json", "data": "{}" } }, "docs": "Decline Invite to Workspace" }, { "info": { "name": "Impersonate a Service Account", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/users/impersonate_service_account", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Impersonate a Service Account" }, { "info": { "name": "Exit Service Account Impersonation", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/users/exit_impersonation", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Exit Service Account Impersonation" }, { "info": { "name": "Whois", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/users/whois/:username", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "username", "value": "", "type": "path" } ] }, "docs": "Whois" }, { "info": { "name": "Exists Email", "type": "http" }, "http": { "method": "GET", "url": "/api/users/exists/:email", "params": [ { "name": "email", "value": "", "type": "path" } ] }, "docs": "Exists Email" }, { "info": { "name": "List All Users as Super Admin (require to be Super Amdin)", "type": "http" }, "http": { "method": "GET", "url": "/api/users/list_as_super_admin", "params": [ { "name": "page", "value": "", "type": "query", "description": "which page to return (start at 1, default 1)" }, { "name": "per_page", "value": "", "type": "query", "description": "number of items to return for a given page (default 30, max 100)" }, { "name": "active_only", "value": "", "type": "query", "description": "filter only active users" } ] }, "docs": "List All Users as Super Admin (require to be Super Amdin)" }, { "info": { "name": "List Users", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/users/list", "params": [ { "name": "workspace", "value": "", "type": "path" } ] }, "docs": "List Users" }, { "info": { "name": "List Users Usage", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/users/list_usage", "params": [ { "name": "workspace", "value": "", "type": "path" } ] }, "docs": "List Users Usage" }, { "info": { "name": "List Usernames", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/users/list_usernames", "params": [ { "name": "workspace", "value": "", "type": "path" } ] }, "docs": "List Usernames" }, { "info": { "name": "Get Email from Username", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/users/username_to_email/:username", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "username", "value": "", "type": "path" } ] }, "docs": "Get Email from Username" }, { "info": { "name": "Create Token", "type": "http" }, "http": { "method": "POST", "url": "/api/users/tokens/create", "body": { "type": "json", "data": "{}" } }, "docs": "Create Token" }, { "info": { "name": "Create Token to Impersonate a User (require Superadmin)", "type": "http" }, "http": { "method": "POST", "url": "/api/users/tokens/impersonate", "body": { "type": "json", "data": "{}" } }, "docs": "Create Token to Impersonate a User (require Superadmin)" }, { "info": { "name": "Delete Token", "type": "http" }, "http": { "method": "DELETE", "url": "/api/users/tokens/delete/:token_prefix", "params": [ { "name": "token_prefix", "value": "", "type": "path" } ] }, "docs": "Delete Token" }, { "info": { "name": "Update Scopes of an Existing Token (owner Only)", "type": "http" }, "http": { "method": "POST", "url": "/api/users/tokens/update_scopes/:token_prefix", "params": [ { "name": "token_prefix", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update Scopes of an Existing Token (owner Only)" }, { "info": { "name": "List Token", "type": "http" }, "http": { "method": "GET", "url": "/api/users/tokens/list", "params": [ { "name": "exclude_ephemeral", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query", "description": "which page to return (start at 1, default 1)" }, { "name": "per_page", "value": "", "type": "query", "description": "number of items to return for a given page (default 30, max 100)" } ] }, "docs": "List Token" }, { "info": { "name": "Login with Oauth Authorization Flow", "type": "http" }, "http": { "method": "POST", "url": "/api/oauth/login_callback/:client_name", "params": [ { "name": "client_name", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Login with Oauth Authorization Flow" } ] }, { "info": { "name": "Git Sync", "type": "folder" }, "items": [ { "info": { "name": "Get Connected Repositories", "type": "http" }, "http": { "method": "GET", "url": "/api/github_app/connected_repositories", "params": [ { "name": "page", "value": "", "type": "query", "description": "Page number for pagination (default 1)" } ] }, "docs": "Get Connected Repositories" }, { "info": { "name": "Install a GitHub Installation from Another Workspace", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/github_app/install_from_workspace", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Install a GitHub Installation from Another Workspace" }, { "info": { "name": "Delete a GitHub Installation from a Workspace", "type": "http" }, "http": { "method": "DELETE", "url": "/api/w/:workspace/github_app/installation/:installation_id", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "installation_id", "value": "", "type": "path", "description": "The ID of the GitHub installation to delete" } ] }, "docs": "Removes a GitHub installation from the specified workspace. Requires admin privileges." }, { "info": { "name": "Export GitHub Installation JWT Token", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/github_app/export/:installationId", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "installationId", "value": "", "type": "path" } ] }, "docs": "Exports the JWT token for a specific GitHub installation in the workspace" }, { "info": { "name": "Import GitHub Installation from JWT Token", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/github_app/import", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Imports a GitHub installation from a JWT token exported from another instance" }, { "info": { "name": "GHES Installation Callback", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/github_app/ghes_installation_callback", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Register a self-managed GitHub App installation from GitHub Enterprise Server" }, { "info": { "name": "Get GHES App Config", "type": "http" }, "http": { "method": "GET", "url": "/api/github_app/ghes_config" }, "docs": "Returns the GitHub Enterprise Server app configuration (without private key) for constructing the installation URL" } ] }, { "info": { "name": "workspace", "type": "folder" }, "items": [ { "info": { "name": "List All Workspaces Visible to Me", "type": "http" }, "http": { "method": "GET", "url": "/api/workspaces/list" }, "docs": "List All Workspaces Visible to Me" }, { "info": { "name": "Is Domain Allowed for Auto Invi", "type": "http" }, "http": { "method": "GET", "url": "/api/workspaces/allowed_domain_auto_invite" }, "docs": "Is Domain Allowed for Auto Invi" }, { "info": { "name": "List All Workspaces Visible to Me with User Info", "type": "http" }, "http": { "method": "GET", "url": "/api/workspaces/users" }, "docs": "List All Workspaces Visible to Me with User Info" }, { "info": { "name": "Get Workspace as Super Admin (require to be Super Admin)", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/workspaces/get_as_superadmin", "params": [ { "name": "workspace", "value": "", "type": "path" } ] }, "docs": "Get Workspace as Super Admin (require to be Super Admin)" }, { "info": { "name": "List All Workspaces as Super Admin (require to be Super Admin)", "type": "http" }, "http": { "method": "GET", "url": "/api/workspaces/list_as_superadmin", "params": [ { "name": "page", "value": "", "type": "query", "description": "which page to return (start at 1, default 1)" }, { "name": "per_page", "value": "", "type": "query", "description": "number of items to return for a given page (default 30, max 100)" } ] }, "docs": "List All Workspaces as Super Admin (require to be Super Admin)" }, { "info": { "name": "Create Workspace", "type": "http" }, "http": { "method": "POST", "url": "/api/workspaces/create", "body": { "type": "json", "data": "{}" } }, "docs": "Create Workspace" }, { "info": { "name": "Create Forked Workspace Branch with Git Sync", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/workspaces/create_workspace_fork_branch", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create Forked Workspace Branch with Git Sync" }, { "info": { "name": "Create Forked Workspace", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/workspaces/create_fork", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create Forked Workspace" }, { "info": { "name": "Exists Workspace", "type": "http" }, "http": { "method": "POST", "url": "/api/workspaces/exists", "body": { "type": "json", "data": "{}" } }, "docs": "Exists Workspace" }, { "info": { "name": "Exists Username", "type": "http" }, "http": { "method": "POST", "url": "/api/workspaces/exists_username", "body": { "type": "json", "data": "{}" } }, "docs": "Exists Username" }, { "info": { "name": "Get Github App Token", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/github_app/token", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Get Github App Token" }, { "info": { "name": "Invite User to Workspace", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/workspaces/invite_user", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Invite User to Workspace" }, { "info": { "name": "Add User to Workspace", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/workspaces/add_user", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add User to Workspace" }, { "info": { "name": "Create a Service Account", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/workspaces/create_service_account", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a Service Account" }, { "info": { "name": "Delete User Invite", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/workspaces/delete_invite", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete User Invite" }, { "info": { "name": "Archive Workspace", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/workspaces/archive", "params": [ { "name": "workspace", "value": "", "type": "path" } ] }, "docs": "Archive Workspace" }, { "info": { "name": "Unarchive Workspace", "type": "http" }, "http": { "method": "POST", "url": "/api/workspaces/unarchive/:workspace", "params": [ { "name": "workspace", "value": "", "type": "path" } ] }, "docs": "Unarchive Workspace" }, { "info": { "name": "Delete Workspace (require Super Admin)", "type": "http" }, "http": { "method": "DELETE", "url": "/api/workspaces/delete/:workspace", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "only_delete_forks", "value": "", "type": "query" } ] }, "docs": "Delete Workspace (require Super Admin)" }, { "info": { "name": "Leave Workspace", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/workspaces/leave", "params": [ { "name": "workspace", "value": "", "type": "path" } ] }, "docs": "Leave Workspace" }, { "info": { "name": "Get Workspace Name", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/workspaces/get_workspace_name", "params": [ { "name": "workspace", "value": "", "type": "path" } ] }, "docs": "Get Workspace Name" }, { "info": { "name": "Change Workspace Name", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/workspaces/change_workspace_name", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Change Workspace Name" }, { "info": { "name": "Change Workspace Id", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/workspaces/change_workspace_id", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Change Workspace Id" }, { "info": { "name": "Change Workspace Id", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/workspaces/change_workspace_color", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Change Workspace Id" }, { "info": { "name": "Update Operator Settings for a Workspace", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/workspaces/operator_settings", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the operator settings for a specific workspace. Requires workspace admin privileges." }, { "info": { "name": "Compare Two Workspaces", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/workspaces/compare/:target_workspace_id", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "target_workspace_id", "value": "", "type": "path", "description": "The ID of the workspace to compare with" } ] }, "docs": "Compares the current workspace with a target workspace to find differences in scripts, flows, apps, resources, and variables. Returns information about items that are ahead, behind, or in conflict." }, { "info": { "name": "Resets the Ahead and Behind Deployement Counter After a Deployement", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/workspaces/reset_diff_tally/:fork_workspace_id", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "fork_workspace_id", "value": "", "type": "path", "description": "The ID of the workspace to compare with" } ] }, "docs": "This endpoint should be called after a fork deployement" }, { "info": { "name": "List Pending Invites for a Workspace", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/workspaces/list_pending_invites", "params": [ { "name": "workspace", "value": "", "type": "path" } ] }, "docs": "List Pending Invites for a Workspace" }, { "info": { "name": "Get Public Settings", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/workspaces/get_public_settings", "params": [ { "name": "workspace", "value": "", "type": "path" } ] }, "docs": "Returns the subset of workspace settings safe to expose to any workspace member. The full settings struct is admin-only via `getSettings`." }, { "info": { "name": "Get Settings (admin Only)", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/workspaces/get_settings", "params": [ { "name": "workspace", "value": "", "type": "path" } ] }, "docs": "Returns the full workspace settings including admin-managed integration credentials. Admin-only — non-admin callers should use `getPublicSettings`." }, { "info": { "name": "Get Deploy to", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/workspaces/get_deploy_to", "params": [ { "name": "workspace", "value": "", "type": "path" } ] }, "docs": "Get Deploy to" }, { "info": { "name": "Get if Workspace is Premium", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/workspaces/is_premium", "params": [ { "name": "workspace", "value": "", "type": "path" } ] }, "docs": "Get if Workspace is Premium" }, { "info": { "name": "Get Premium Info", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/workspaces/premium_info", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "skip_subscription_fetch", "value": "", "type": "query", "description": "skip fetching subscription status from stripe" } ] }, "docs": "Get Premium Info" }, { "info": { "name": "Get Threshold Alert Info", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/workspaces/threshold_alert", "params": [ { "name": "workspace", "value": "", "type": "path" } ] }, "docs": "Get Threshold Alert Info" }, { "info": { "name": "Set Threshold Alert Info", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/workspaces/threshold_alert", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Set Threshold Alert Info" }, { "info": { "name": "Rebuild Dependency Map", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/workspaces/rebuild_dependency_map", "params": [ { "name": "workspace", "value": "", "type": "path" } ] }, "docs": "Rebuild Dependency Map" }, { "info": { "name": "Get Dependents of an Imported Path", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/workspaces/get_dependents/:imported_path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "imported_path", "value": "", "type": "path", "description": "The imported path to get dependents for" } ] }, "docs": "Get Dependents of an Imported Path" }, { "info": { "name": "Get Script Imports for an Importer Path", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/workspaces/get_imports/:importer_path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "importer_path", "value": "", "type": "path", "description": "The script path to get imports for" } ] }, "docs": "Get Script Imports for an Importer Path" }, { "info": { "name": "Get Dependents Amounts for Multiple Imported Paths", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/workspaces/get_dependents_amounts", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Get Dependents Amounts for Multiple Imported Paths" }, { "info": { "name": "Get Dependency Map", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/workspaces/get_dependency_map", "params": [ { "name": "workspace", "value": "", "type": "path" } ] }, "docs": "Get Dependency Map" }, { "info": { "name": "Edit Slack Command", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/workspaces/edit_slack_command", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Edit Slack Command" }, { "info": { "name": "Get Workspace Slack Oauth Config", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/workspaces/slack_oauth_config", "params": [ { "name": "workspace", "value": "", "type": "path" } ] }, "docs": "Get Workspace Slack Oauth Config" }, { "info": { "name": "Set Workspace Slack Oauth Config", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/workspaces/slack_oauth_config", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Set Workspace Slack Oauth Config" }, { "info": { "name": "Delete Workspace Slack Oauth Config", "type": "http" }, "http": { "method": "DELETE", "url": "/api/w/:workspace/workspaces/slack_oauth_config", "params": [ { "name": "workspace", "value": "", "type": "path" } ] }, "docs": "Delete Workspace Slack Oauth Config" }, { "info": { "name": "Edit Teams Command", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/workspaces/edit_teams_command", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Edit Teams Command" }, { "info": { "name": "List Available Teams Ids", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/workspaces/available_teams_ids", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "search", "value": "", "type": "query", "description": "Search teams by name. If omitted, returns first page of all teams." }, { "name": "next_link", "value": "", "type": "query", "description": "Pagination cursor URL from previous response. Pass this to fetch the next page of results." } ] }, "docs": "List Available Teams Ids" }, { "info": { "name": "List Available Channels for a Specific Team", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/workspaces/available_teams_channels", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "team_id", "value": "", "type": "query", "description": "Microsoft Teams team ID" } ] }, "docs": "List Available Channels for a Specific Team" }, { "info": { "name": "Connect Teams", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/workspaces/connect_teams", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Connect Teams" }, { "info": { "name": "Connect Slack (non-interactive; Pre-minted Bot Token)", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/workspaces/connect_slack", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Connect Slack (non-interactive; Pre-minted Bot Token)" }, { "info": { "name": "Run a Job that Sends a Message to Slack", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/workspaces/run_slack_message_test_job", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Run a Job that Sends a Message to Slack" }, { "info": { "name": "Run a Job that Sends a Message to Teams", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/workspaces/run_teams_message_test_job", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Run a Job that Sends a Message to Teams" }, { "info": { "name": "Edit Deploy to", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/workspaces/edit_deploy_to", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Edit Deploy to" }, { "info": { "name": "Edit Auto Invite", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/workspaces/edit_auto_invite", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Edit Auto Invite" }, { "info": { "name": "Edit Instance Groups", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/workspaces/edit_instance_groups", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Edit Instance Groups" }, { "info": { "name": "Edit Webhook", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/workspaces/edit_webhook", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Edit Webhook" }, { "info": { "name": "Edit Copilot Config", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/workspaces/edit_copilot_config", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Edit Copilot Config" }, { "info": { "name": "Get Copilot Settings State", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/workspaces/get_copilot_settings_state", "params": [ { "name": "workspace", "value": "", "type": "path" } ] }, "docs": "Get Copilot Settings State" }, { "info": { "name": "Get Copilot Info", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/workspaces/get_copilot_info", "params": [ { "name": "workspace", "value": "", "type": "path" } ] }, "docs": "Get Copilot Info" }, { "info": { "name": "Edit Error Handler", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/workspaces/edit_error_handler", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Edit Error Handler" }, { "info": { "name": "Edit Success Handler", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/workspaces/edit_success_handler", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Edit Success Handler" }, { "info": { "name": "Edit Large File Storage Settings", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/workspaces/edit_large_file_storage_config", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Edit Large File Storage Settings" }, { "info": { "name": "List Ducklakes", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/workspaces/list_ducklakes", "params": [ { "name": "workspace", "value": "", "type": "path" } ] }, "docs": "List Ducklakes" }, { "info": { "name": "List Datatables", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/workspaces/list_datatables", "params": [ { "name": "workspace", "value": "", "type": "path" } ] }, "docs": "List Datatables" }, { "info": { "name": "List Schemas of All Connected Datatables", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/workspaces/list_datatable_schemas", "params": [ { "name": "workspace", "value": "", "type": "path" } ] }, "docs": "List Schemas of All Connected Datatables" }, { "info": { "name": "List Tables of All Connected Datatables", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/workspaces/list_datatable_tables", "params": [ { "name": "workspace", "value": "", "type": "path" } ] }, "docs": "List Tables of All Connected Datatables" }, { "info": { "name": "Get One Datatable Table Schema", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/workspaces/get_datatable_table_schema", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "datatable_name", "value": "", "type": "query" }, { "name": "schema_name", "value": "", "type": "query" }, { "name": "table_name", "value": "", "type": "query" } ] }, "docs": "Get One Datatable Table Schema" }, { "info": { "name": "Edit Ducklake Settings", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/workspaces/edit_ducklake_config", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Edit Ducklake Settings" }, { "info": { "name": "Edit Datatable Settings", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/workspaces/edit_datatable_config", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Edit Datatable Settings" }, { "info": { "name": "Create a New PostgreSQL Database for a Datatable", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/workspaces/create_pg_database", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a New PostgreSQL Database for a Datatable" }, { "info": { "name": "Drop Forked Datatable Databases", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/workspaces/drop_forked_datatable_databases", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Drop Forked Datatable Databases" }, { "info": { "name": "Import a PostgreSQL Database from Source to Target via Pg_dump", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/workspaces/import_pg_database", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Import a PostgreSQL Database from Source to Target via Pg_dump" }, { "info": { "name": "Export the Schema of a PostgreSQL Database", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/workspaces/export_pg_schema", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Export the Schema of a PostgreSQL Database" }, { "info": { "name": "Get the Full Schema of a Datatable Database as TableEditorValues", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/workspaces/get_datatable_full_schema", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Get the Full Schema of a Datatable Database as TableEditorValues" }, { "info": { "name": "Check if Git Sync is Available for this Workspace", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/workspaces/git_sync_enabled", "params": [ { "name": "workspace", "value": "", "type": "path" } ] }, "docs": "Check if Git Sync is Available for this Workspace" }, { "info": { "name": "Edit Workspace Git Sync Settings", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/workspaces/edit_git_sync_config", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Edit Workspace Git Sync Settings" }, { "info": { "name": "Add or Update Individual Git Sync Repository", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/workspaces/edit_git_sync_repository", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add or Update Individual Git Sync Repository" }, { "info": { "name": "Delete Individual Git Sync Repository", "type": "http" }, "http": { "method": "DELETE", "url": "/api/w/:workspace/workspaces/delete_git_sync_repository", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete Individual Git Sync Repository" }, { "info": { "name": "Edit Workspace Deploy Ui Settings", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/workspaces/edit_deploy_ui_config", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Edit Workspace Deploy Ui Settings" }, { "info": { "name": "Edit Default App for Workspace", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/workspaces/edit_default_app", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Edit Default App for Workspace" }, { "info": { "name": "Get Default Scripts for Workspace", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/workspaces/default_scripts", "params": [ { "name": "workspace", "value": "", "type": "path" } ] }, "docs": "Get Default Scripts for Workspace" }, { "info": { "name": "Edit Default Scripts for Workspace", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/workspaces/default_scripts", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Edit Default Scripts for Workspace" }, { "info": { "name": "Set Environment Variable", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/workspaces/set_environment_variable", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Set Environment Variable" }, { "info": { "name": "Retrieves the Encryption Key for this Workspace", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/workspaces/encryption_key", "params": [ { "name": "workspace", "value": "", "type": "path" } ] }, "docs": "Retrieves the Encryption Key for this Workspace" }, { "info": { "name": "Update the Encryption Key for this Workspace", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/workspaces/encryption_key", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the Encryption Key for this Workspace" }, { "info": { "name": "Get Default App for Workspace", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/workspaces/default_app", "params": [ { "name": "workspace", "value": "", "type": "path" } ] }, "docs": "Get Default App for Workspace" }, { "info": { "name": "Get Usage", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/workspaces/usage", "params": [ { "name": "workspace", "value": "", "type": "path" } ] }, "docs": "Get Usage" }, { "info": { "name": "Get Used Triggers", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/workspaces/used_triggers", "params": [ { "name": "workspace", "value": "", "type": "path" } ] }, "docs": "Get Used Triggers" }, { "info": { "name": "List All Protection Rules for a Workspace", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/workspaces/protection_rules", "params": [ { "name": "workspace", "value": "", "type": "path" } ] }, "docs": "List All Protection Rules for a Workspace" }, { "info": { "name": "Create a New Protection Rule", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/workspaces/protection_rules", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a New Protection Rule" }, { "info": { "name": "Update an Existing Protection Rule", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/workspaces/protection_rules/:rule_name", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "rule_name", "value": "", "type": "path", "description": "Name of the protection rule to update" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an Existing Protection Rule" }, { "info": { "name": "Delete a Protection Rule", "type": "http" }, "http": { "method": "DELETE", "url": "/api/w/:workspace/workspaces/protection_rules/:rule_name", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "rule_name", "value": "", "type": "path", "description": "Name of the protection rule to delete" } ] }, "docs": "Delete a Protection Rule" }, { "info": { "name": "List Users Eligible to be Deployment Request Assignees", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/deployment_request/eligible_deployers", "params": [ { "name": "workspace", "value": "", "type": "path" } ] }, "docs": "Returns admins and members of wm_deployers in the parent workspace of the fork at `{workspace}`." }, { "info": { "name": "Get the Currently Open Deployment Request for this Fork", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/deployment_request/open", "params": [ { "name": "workspace", "value": "", "type": "path" } ] }, "docs": "Get the Currently Open Deployment Request for this Fork" }, { "info": { "name": "Create a New Deployment Request", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/deployment_request", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a New Deployment Request" }, { "info": { "name": "Cancel an Open Deployment Request", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/deployment_request/:id/cancel", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Cancel an Open Deployment Request" }, { "info": { "name": "Close a Deployment Request After a Successful Merge", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/deployment_request/:id/close_merged", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Called by the UI after the deploy loop completes. Closes the request and marks every comment obsolete. Idempotent." }, { "info": { "name": "Append a Comment to an Open Deployment Request", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/deployment_request/:id/comment", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Append a Comment to an Open Deployment Request" }, { "info": { "name": "Log AI Chat Message", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/workspaces/log_chat", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Log AI Chat Message" }, { "info": { "name": "Get Cloud Quota Usage and Limits for Workspace", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/workspaces/cloud_quotas", "params": [ { "name": "workspace", "value": "", "type": "path" } ] }, "docs": "Get Cloud Quota Usage and Limits for Workspace" }, { "info": { "name": "Prune Old Versions of Scripts, Flows, or Apps", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/workspaces/prune_versions", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Prune Old Versions of Scripts, Flows, or Apps" }, { "info": { "name": "Get the Workspace Shared UI Folder (full Content)", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/shared_ui/get", "params": [ { "name": "workspace", "value": "", "type": "path" } ] }, "docs": "Get the Workspace Shared UI Folder (full Content)" }, { "info": { "name": "List Paths/sizes of the Workspace Shared UI Folder", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/shared_ui/list", "params": [ { "name": "workspace", "value": "", "type": "path" } ] }, "docs": "List Paths/sizes of the Workspace Shared UI Folder" }, { "info": { "name": "Get the Current Version of the Workspace Shared UI Folder", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/shared_ui/version", "params": [ { "name": "workspace", "value": "", "type": "path" } ] }, "docs": "Get the Current Version of the Workspace Shared UI Folder" }, { "info": { "name": "Replace the Workspace Shared UI Folder (admin Only)", "type": "http" }, "http": { "method": "PUT", "url": "/api/w/:workspace/shared_ui", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Replace the Workspace Shared UI Folder (admin Only)" } ] }, { "info": { "name": "setting", "type": "folder" }, "items": [ { "info": { "name": "Refreshes the Password for the Custom_instance_user", "type": "http" }, "http": { "method": "POST", "url": "/api/settings/refresh_custom_instance_user_pwd" }, "docs": "Refreshes the Password for the Custom_instance_user" }, { "info": { "name": "Returns the Set-up Statuses of Custom Instance Pg Databases", "type": "http" }, "http": { "method": "POST", "url": "/api/settings/list_custom_instance_pg_databases" }, "docs": "Returns the Set-up Statuses of Custom Instance Pg Databases" }, { "info": { "name": "Runs CREATE DATABASE on the Windmill Postgres and Grants Access to the Custom_instance_user", "type": "http" }, "http": { "method": "POST", "url": "/api/settings/setup_custom_instance_pg_database/:name", "params": [ { "name": "name", "value": "", "type": "path", "description": "The name of the database to create" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Runs CREATE DATABASE on the Windmill Postgres and Grants Access to the Custom_instance_user" }, { "info": { "name": "Drops a Custom Instance Database (superadmin Only, Irreversible)", "type": "http" }, "http": { "method": "POST", "url": "/api/settings/drop_custom_instance_pg_database/:name", "params": [ { "name": "name", "value": "", "type": "path", "description": "The name of the database to drop" } ] }, "docs": "Drops a Custom Instance Database (superadmin Only, Irreversible)" }, { "info": { "name": "Get Global Settings", "type": "http" }, "http": { "method": "GET", "url": "/api/settings/global/:key", "params": [ { "name": "key", "value": "", "type": "path" } ] }, "docs": "Get Global Settings" }, { "info": { "name": "Post Global Settings", "type": "http" }, "http": { "method": "POST", "url": "/api/settings/global/:key", "params": [ { "name": "key", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Post Global Settings" }, { "info": { "name": "Get Instance Ruff Config (unauthenticated)", "type": "http" }, "http": { "method": "GET", "url": "/api/settings_u/ruff_config" }, "docs": "Returns the instance-level ruff.toml content as plain text.\nIntentionally unauthenticated so the LSP extra container can poll it\nacross any deployment topology. Responds with an empty body when the\ninstance config is unset. Ruff configuration is lint/format policy,\nnot a credential.\n" }, { "info": { "name": "Get Local Settings", "type": "http" }, "http": { "method": "GET", "url": "/api/settings/local" }, "docs": "Get Local Settings" }, { "info": { "name": "Test Smtp", "type": "http" }, "http": { "method": "POST", "url": "/api/settings/test_smtp", "body": { "type": "json", "data": "{}" } }, "docs": "Test Smtp" }, { "info": { "name": "Test Critical Channels", "type": "http" }, "http": { "method": "POST", "url": "/api/settings/test_critical_channels", "body": { "type": "json", "data": "{}" } }, "docs": "Test Critical Channels" }, { "info": { "name": "Get All Critical Alerts", "type": "http" }, "http": { "method": "GET", "url": "/api/settings/critical_alerts", "params": [ { "name": "page", "value": "", "type": "query" }, { "name": "page_size", "value": "", "type": "query" }, { "name": "acknowledged", "value": "", "type": "query" } ] }, "docs": "Get All Critical Alerts" }, { "info": { "name": "Acknowledge a Critical Alert", "type": "http" }, "http": { "method": "POST", "url": "/api/settings/critical_alerts/:id/acknowledge", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the critical alert to acknowledge" } ] }, "docs": "Acknowledge a Critical Alert" }, { "info": { "name": "Acknowledge All Unacknowledged Critical Alerts", "type": "http" }, "http": { "method": "POST", "url": "/api/settings/critical_alerts/acknowledge_all" }, "docs": "Acknowledge All Unacknowledged Critical Alerts" }, { "info": { "name": "Test License Key", "type": "http" }, "http": { "method": "POST", "url": "/api/settings/test_license_key", "body": { "type": "json", "data": "{}" } }, "docs": "Test License Key" }, { "info": { "name": "Test Object Storage Config", "type": "http" }, "http": { "method": "POST", "url": "/api/settings/test_object_storage_config", "body": { "type": "json", "data": "{}" } }, "docs": "Test Object Storage Config" }, { "info": { "name": "Get Current or Last Object Storage Usage Computation (null if Never Run)", "type": "http" }, "http": { "method": "GET", "url": "/api/settings/object_storage_usage" }, "docs": "Get Current or Last Object Storage Usage Computation (null if Never Run)" }, { "info": { "name": "Start a Background Computation of Object Storage Usage by Top-level Folder", "type": "http" }, "http": { "method": "POST", "url": "/api/settings/object_storage_usage" }, "docs": "Start a Background Computation of Object Storage Usage by Top-level Folder" }, { "info": { "name": "Start a Manual Cleanup of Expired Logs from Object Storage", "type": "http" }, "http": { "method": "POST", "url": "/api/settings/run_log_cleanup" }, "docs": "Start a Manual Cleanup of Expired Logs from Object Storage" }, { "info": { "name": "Get Status of the Manual Log Cleanup Task", "type": "http" }, "http": { "method": "GET", "url": "/api/settings/log_cleanup_status" }, "docs": "Get Status of the Manual Log Cleanup Task" }, { "info": { "name": "Send Stats", "type": "http" }, "http": { "method": "POST", "url": "/api/settings/send_stats" }, "docs": "Send Stats" }, { "info": { "name": "Restart Worker Group", "type": "http" }, "http": { "method": "POST", "url": "/api/settings/restart_worker_group/:worker_group", "params": [ { "name": "worker_group", "value": "", "type": "path", "description": "the name of the worker group to restart" } ] }, "docs": "Send a restart signal to all workers in the specified worker group. Workers will gracefully shut down and are expected to be restarted by their supervisor. Requires devops role." }, { "info": { "name": "Get Telemetry Stats with HMAC Signature (EE Only)", "type": "http" }, "http": { "method": "GET", "url": "/api/settings/get_stats" }, "docs": "Get Telemetry Stats with HMAC Signature (EE Only)" }, { "info": { "name": "Get Latest Key Renewal Attempt", "type": "http" }, "http": { "method": "GET", "url": "/api/settings/latest_key_renewal_attempt" }, "docs": "Get Latest Key Renewal Attempt" }, { "info": { "name": "Renew License Key", "type": "http" }, "http": { "method": "POST", "url": "/api/settings/renew_license_key", "params": [ { "name": "license_key", "value": "", "type": "query" } ] }, "docs": "Renew License Key" }, { "info": { "name": "Create Customer Portal Session", "type": "http" }, "http": { "method": "POST", "url": "/api/settings/customer_portal", "params": [ { "name": "license_key", "value": "", "type": "query" } ] }, "docs": "Create Customer Portal Session" }, { "info": { "name": "Test Metadata", "type": "http" }, "http": { "method": "POST", "url": "/api/saml/test_metadata", "body": { "type": "json", "data": "{}" } }, "docs": "Test Metadata" }, { "info": { "name": "List Global Settings", "type": "http" }, "http": { "method": "GET", "url": "/api/settings/list_global" }, "docs": "List Global Settings" }, { "info": { "name": "Get Full Instance Config (global Settings + Worker Configs)", "type": "http" }, "http": { "method": "GET", "url": "/api/settings/instance_config" }, "docs": "Get Full Instance Config (global Settings + Worker Configs)" }, { "info": { "name": "Update Instance Config (bulk Upsert, No Deletes). Empty or Missing Global_settings/worker_configs are Skipped.", "type": "http" }, "http": { "method": "PUT", "url": "/api/settings/instance_config", "body": { "type": "json", "data": "{}" } }, "docs": "Update Instance Config (bulk Upsert, No Deletes). Empty or Missing Global_settings/worker_configs are Skipped." }, { "info": { "name": "Get Minimum Worker Versions Required to Stay Alive", "type": "http" }, "http": { "method": "GET", "url": "/api/min_keep_alive_version" }, "docs": "Get Minimum Worker Versions Required to Stay Alive" }, { "info": { "name": "Get JWKS for Vault JWT Authentication", "type": "http" }, "http": { "method": "GET", "url": "/api/.well-known/jwks.json" }, "docs": "Get JWKS for Vault JWT Authentication" }, { "info": { "name": "Test Secret Backend Connection (HashiCorp Vault)", "type": "http" }, "http": { "method": "POST", "url": "/api/settings/test_secret_backend", "body": { "type": "json", "data": "{}" } }, "docs": "Test Secret Backend Connection (HashiCorp Vault)" }, { "info": { "name": "Migrate Secrets from Database to HashiCorp Vault", "type": "http" }, "http": { "method": "POST", "url": "/api/settings/migrate_secrets_to_vault", "body": { "type": "json", "data": "{}" } }, "docs": "Migrate Secrets from Database to HashiCorp Vault" }, { "info": { "name": "Migrate Secrets from HashiCorp Vault to Database", "type": "http" }, "http": { "method": "POST", "url": "/api/settings/migrate_secrets_to_database", "body": { "type": "json", "data": "{}" } }, "docs": "Migrate Secrets from HashiCorp Vault to Database" }, { "info": { "name": "Test Azure Key Vault Connection", "type": "http" }, "http": { "method": "POST", "url": "/api/settings/test_azure_kv_backend", "body": { "type": "json", "data": "{}" } }, "docs": "Test Azure Key Vault Connection" }, { "info": { "name": "Migrate Secrets from Database to Azure Key Vault", "type": "http" }, "http": { "method": "POST", "url": "/api/settings/migrate_secrets_to_azure_kv", "body": { "type": "json", "data": "{}" } }, "docs": "Migrate Secrets from Database to Azure Key Vault" }, { "info": { "name": "Migrate Secrets from Azure Key Vault to Database", "type": "http" }, "http": { "method": "POST", "url": "/api/settings/migrate_secrets_from_azure_kv", "body": { "type": "json", "data": "{}" } }, "docs": "Migrate Secrets from Azure Key Vault to Database" }, { "info": { "name": "Test Connection to AWS Secrets Manager", "type": "http" }, "http": { "method": "POST", "url": "/api/settings/test_aws_sm_backend", "body": { "type": "json", "data": "{}" } }, "docs": "Test Connection to AWS Secrets Manager" }, { "info": { "name": "Migrate Secrets from Database to AWS Secrets Manager", "type": "http" }, "http": { "method": "POST", "url": "/api/settings/migrate_secrets_to_aws_sm", "body": { "type": "json", "data": "{}" } }, "docs": "Migrate Secrets from Database to AWS Secrets Manager" }, { "info": { "name": "Migrate Secrets from AWS Secrets Manager to Database", "type": "http" }, "http": { "method": "POST", "url": "/api/settings/migrate_secrets_from_aws_sm", "body": { "type": "json", "data": "{}" } }, "docs": "Migrate Secrets from AWS Secrets Manager to Database" }, { "info": { "name": "Get Secondary Storage Names", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/workspaces/get_secondary_storage_names", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "include_default", "value": "", "type": "query", "description": "If true, include \"_default_\" in the list if primary workspace storage is set" } ] }, "docs": "Get Secondary Storage Names" }, { "info": { "name": "Get All Critical Alerts for this Workspace", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/workspaces/critical_alerts", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query" }, { "name": "page_size", "value": "", "type": "query" }, { "name": "acknowledged", "value": "", "type": "query" } ] }, "docs": "Get All Critical Alerts for this Workspace" }, { "info": { "name": "Acknowledge a Critical Alert for this Workspace", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/workspaces/critical_alerts/:id/acknowledge", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path", "description": "The ID of the critical alert to acknowledge" } ] }, "docs": "Acknowledge a Critical Alert for this Workspace" }, { "info": { "name": "Acknowledge All Unacknowledged Critical Alerts for this Workspace", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/workspaces/critical_alerts/acknowledge_all", "params": [ { "name": "workspace", "value": "", "type": "path" } ] }, "docs": "Acknowledge All Unacknowledged Critical Alerts for this Workspace" }, { "info": { "name": "Mute Critical Alert UI for this Workspace", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/workspaces/critical_alerts/mute", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Mute Critical Alert UI for this Workspace" }, { "info": { "name": "Set Public App Rate Limit for this Workspace", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/workspaces/public_app_rate_limit", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Set Public App Rate Limit for this Workspace" } ] }, { "info": { "name": "token", "type": "folder" }, "items": [ { "info": { "name": "List of Available Scopes", "type": "http" }, "http": { "method": "GET", "url": "/api/tokens/list/scopes" }, "docs": "List of Available Scopes" } ] }, { "info": { "name": "oidc", "type": "folder" }, "items": [ { "info": { "name": "Get OIDC Token (ee Only)", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/oidc/token/:audience", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "audience", "value": "", "type": "path" }, { "name": "expires_in", "value": "", "type": "query" } ] }, "docs": "Get OIDC Token (ee Only)" } ] }, { "info": { "name": "variable", "type": "folder" }, "items": [ { "info": { "name": "Create Variable", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/variables/create", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "already_encrypted", "value": "", "type": "query", "description": "whether the variable is already encrypted (default false)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create Variable" }, { "info": { "name": "Encrypt Value", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/variables/encrypt", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Encrypt Value" }, { "info": { "name": "Delete Variable", "type": "http" }, "http": { "method": "DELETE", "url": "/api/w/:workspace/variables/delete/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "Delete Variable" }, { "info": { "name": "Delete Variables in Bulk", "type": "http" }, "http": { "method": "DELETE", "url": "/api/w/:workspace/variables/delete_bulk", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete Variables in Bulk" }, { "info": { "name": "Update Variable", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/variables/update/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" }, { "name": "already_encrypted", "value": "", "type": "query", "description": "whether the variable is already encrypted (default false)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update Variable" }, { "info": { "name": "Get Variable", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/variables/get/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" }, { "name": "decrypt_secret", "value": "", "type": "query", "description": "ask to decrypt secret if this variable is secret\n(if not secret no effect, default: true)\n" }, { "name": "include_encrypted", "value": "", "type": "query", "description": "ask to include the encrypted value if secret and decrypt secret is not true (default: false)\n" } ] }, "docs": "Get Variable" }, { "info": { "name": "Get Variable Value", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/variables/get_value/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" }, { "name": "allow_cache", "value": "", "type": "query", "description": "allow getting a cached value for improved performance\n" } ] }, "docs": "Get Variable Value" }, { "info": { "name": "Does Variable Exists at Path", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/variables/exists/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "Does Variable Exists at Path" }, { "info": { "name": "List Variables", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/variables/list", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path_start", "value": "", "type": "query", "description": "filter variables by path prefix" }, { "name": "path", "value": "", "type": "query", "description": "exact path match filter" }, { "name": "description", "value": "", "type": "query", "description": "pattern match filter for description field (case-insensitive)" }, { "name": "value", "value": "", "type": "query", "description": "pattern match filter for non-secret variable values (case-insensitive)" }, { "name": "broad_filter", "value": "", "type": "query", "description": "broad search across multiple fields (case-insensitive substring match)" }, { "name": "page", "value": "", "type": "query", "description": "which page to return (start at 1, default 1)" }, { "name": "per_page", "value": "", "type": "query", "description": "number of items to return for a given page (default 30, max 100)" }, { "name": "label", "value": "", "type": "query", "description": "Filter by label" } ] }, "docs": "List Variables" }, { "info": { "name": "List Contextual Variables", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/variables/list_contextual", "params": [ { "name": "workspace", "value": "", "type": "path" } ] }, "docs": "List Contextual Variables" } ] }, { "info": { "name": "oauth", "type": "folder" }, "items": [ { "info": { "name": "Connect Slack Callback", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/oauth/connect_slack_callback", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Connect Slack Callback" }, { "info": { "name": "Connect Slack Callback Instance", "type": "http" }, "http": { "method": "POST", "url": "/api/oauth/connect_slack_callback", "body": { "type": "json", "data": "{}" } }, "docs": "Connect Slack Callback Instance" }, { "info": { "name": "Connect Slack Instance (non-interactive; Pre-minted Bot Token)", "type": "http" }, "http": { "method": "POST", "url": "/api/oauth/connect_slack_instance", "body": { "type": "json", "data": "{}" } }, "docs": "Connect Slack Instance (non-interactive; Pre-minted Bot Token)" }, { "info": { "name": "Connect Callback", "type": "http" }, "http": { "method": "POST", "url": "/api/oauth/connect_callback/:client_name", "params": [ { "name": "client_name", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Connect Callback" }, { "info": { "name": "Create OAuth Account", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/oauth/create_account", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create OAuth Account" }, { "info": { "name": "Connect OAuth Using Client Credentials", "type": "http" }, "http": { "method": "POST", "url": "/api/oauth/connect_client_credentials/:client", "params": [ { "name": "client", "value": "", "type": "path", "description": "OAuth client name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Connect OAuth Using Client Credentials" }, { "info": { "name": "Refresh Token", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/oauth/refresh_token/:id", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Refresh Token" }, { "info": { "name": "Disconnect Account", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/oauth/disconnect/:id", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Disconnect Account" }, { "info": { "name": "Disconnect Slack", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/oauth/disconnect_slack", "params": [ { "name": "workspace", "value": "", "type": "path" } ] }, "docs": "Disconnect Slack" }, { "info": { "name": "Disconnect Teams", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/oauth/disconnect_teams", "params": [ { "name": "workspace", "value": "", "type": "path" } ] }, "docs": "Disconnect Teams" }, { "info": { "name": "List Oauth Logins", "type": "http" }, "http": { "method": "GET", "url": "/api/oauth/list_logins" }, "docs": "List Oauth Logins" }, { "info": { "name": "List Oauth Connects", "type": "http" }, "http": { "method": "GET", "url": "/api/oauth/list_connects" }, "docs": "List Oauth Connects" }, { "info": { "name": "Get Oauth Connect", "type": "http" }, "http": { "method": "GET", "url": "/api/oauth/get_connect/:client", "params": [ { "name": "client", "value": "", "type": "path", "description": "client name" } ] }, "docs": "Get Oauth Connect" } ] }, { "info": { "name": "teams", "type": "folder" }, "items": [ { "info": { "name": "Send Update to Microsoft Teams Activity", "type": "http" }, "http": { "method": "POST", "url": "/api/teams/activities", "body": { "type": "json", "data": "{}" } }, "docs": "Respond to a Microsoft Teams activity after a workspace command is run" } ] }, { "info": { "name": "resource", "type": "folder" }, "items": [ { "info": { "name": "Create Resource", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/resources/create", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "update_if_exists", "value": "", "type": "query", "description": "update the resource if it already exists (default false)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create Resource" }, { "info": { "name": "Delete Resource", "type": "http" }, "http": { "method": "DELETE", "url": "/api/w/:workspace/resources/delete/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "Delete Resource" }, { "info": { "name": "Delete Resources in Bulk", "type": "http" }, "http": { "method": "DELETE", "url": "/api/w/:workspace/resources/delete_bulk", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete Resources in Bulk" }, { "info": { "name": "Update Resource", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/resources/update/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update Resource" }, { "info": { "name": "Update Resource Value", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/resources/update_value/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update Resource Value" }, { "info": { "name": "Get Resource", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/resources/get/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "Get Resource" }, { "info": { "name": "Get Resource Interpolated (variables and Resources are Fully Unrolled)", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/resources/get_value_interpolated/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" }, { "name": "job_id", "value": "", "type": "query", "description": "job id" }, { "name": "allow_cache", "value": "", "type": "query", "description": "allow getting a cached value for improved performance" } ] }, "docs": "Get Resource Interpolated (variables and Resources are Fully Unrolled)" }, { "info": { "name": "Get Resource Value", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/resources/get_value/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "Get Resource Value" }, { "info": { "name": "Get Git Repository Latest Commit Hash", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/resources/git_commit_hash/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" }, { "name": "git_ssh_identity", "value": "", "type": "query" } ] }, "docs": "Get Git Repository Latest Commit Hash" }, { "info": { "name": "Does Resource Exists", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/resources/exists/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "Does Resource Exists" }, { "info": { "name": "List Resources", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/resources/list", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query", "description": "which page to return (start at 1, default 1)" }, { "name": "per_page", "value": "", "type": "query", "description": "number of items to return for a given page (default 30, max 100)" }, { "name": "resource_type", "value": "", "type": "query", "description": "resource_types to list from, separated by ','," }, { "name": "resource_type_exclude", "value": "", "type": "query", "description": "resource_types to not list from, separated by ','," }, { "name": "path_start", "value": "", "type": "query", "description": "filter resources by path prefix" }, { "name": "path", "value": "", "type": "query", "description": "exact path match filter" }, { "name": "description", "value": "", "type": "query", "description": "pattern match filter for description field (case-insensitive)" }, { "name": "value", "value": "", "type": "query", "description": "JSONB subset match filter using base64 encoded JSON" }, { "name": "broad_filter", "value": "", "type": "query", "description": "broad search across multiple fields (case-insensitive substring match)" }, { "name": "label", "value": "", "type": "query", "description": "Filter by label" } ] }, "docs": "List Resources" }, { "info": { "name": "List Resources for Search", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/resources/list_search", "params": [ { "name": "workspace", "value": "", "type": "path" } ] }, "docs": "List Resources for Search" }, { "info": { "name": "Get MCP Tools from Resource", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/resources/mcp_tools/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "Get MCP Tools from Resource" }, { "info": { "name": "List Resource Names", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/resources/list_names/:name", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "name", "value": "", "type": "path" } ] }, "docs": "List Resource Names" }, { "info": { "name": "Create Resource_type", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/resources/type/create", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create Resource_type" }, { "info": { "name": "Get Map from Resource Type to Format Extension", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/resources/file_resource_type_to_file_ext_map", "params": [ { "name": "workspace", "value": "", "type": "path" } ] }, "docs": "Get Map from Resource Type to Format Extension" }, { "info": { "name": "Delete Resource_type", "type": "http" }, "http": { "method": "DELETE", "url": "/api/w/:workspace/resources/type/delete/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "Delete Resource_type" }, { "info": { "name": "Update Resource_type", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/resources/type/update/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update Resource_type" }, { "info": { "name": "Get Resource_type", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/resources/type/get/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "Get Resource_type" }, { "info": { "name": "Does Resource_type Exists", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/resources/type/exists/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "Does Resource_type Exists" }, { "info": { "name": "List Resource_types", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/resources/type/list", "params": [ { "name": "workspace", "value": "", "type": "path" } ] }, "docs": "List Resource_types" }, { "info": { "name": "List Resource_types Names", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/resources/type/listnames", "params": [ { "name": "workspace", "value": "", "type": "path" } ] }, "docs": "List Resource_types Names" }, { "info": { "name": "Query Resource Types by Similarity", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/embeddings/query_resource_types", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "text", "value": "", "type": "query", "description": "query text" }, { "name": "limit", "value": "", "type": "query", "description": "query limit" } ] }, "docs": "Query Resource Types by Similarity" } ] }, { "info": { "name": "npm_proxy", "type": "folder" }, "items": [ { "info": { "name": "Get Npm Package Metadata from Private Registry", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/npm_proxy/metadata/:package", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "package", "value": "", "type": "path", "description": "npm package name" } ] }, "docs": "Get Npm Package Metadata from Private Registry" }, { "info": { "name": "Resolve Npm Package Version from Private Registry", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/npm_proxy/resolve/:package", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "package", "value": "", "type": "path", "description": "npm package name" }, { "name": "tag", "value": "", "type": "query", "description": "version tag or reference" } ] }, "docs": "Resolve Npm Package Version from Private Registry" }, { "info": { "name": "Get Npm Package File Tree from Private Registry", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/npm_proxy/filetree/:package/:version", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "package", "value": "", "type": "path", "description": "npm package name" }, { "name": "version", "value": "", "type": "path", "description": "package version" } ] }, "docs": "Get Npm Package File Tree from Private Registry" }, { "info": { "name": "Get Specific File from Npm Package in Private Registry", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/npm_proxy/file/:package/:version/:filepath", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "package", "value": "", "type": "path", "description": "npm package name" }, { "name": "version", "value": "", "type": "path", "description": "package version" }, { "name": "filepath", "value": "", "type": "path", "description": "file path within package" } ] }, "docs": "Get Specific File from Npm Package in Private Registry" } ] }, { "info": { "name": "integration", "type": "folder" }, "items": [ { "info": { "name": "List Hub Integrations", "type": "http" }, "http": { "method": "GET", "url": "/api/integrations/hub/list", "params": [ { "name": "kind", "value": "", "type": "query", "description": "query integrations kind" } ] }, "docs": "List Hub Integrations" } ] }, { "info": { "name": "flow", "type": "folder" }, "items": [ { "info": { "name": "List All Hub Flows", "type": "http" }, "http": { "method": "GET", "url": "/api/flows/hub/list" }, "docs": "List All Hub Flows" }, { "info": { "name": "Get Hub Flow by Id", "type": "http" }, "http": { "method": "GET", "url": "/api/flows/hub/get/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get Hub Flow by Id" }, { "info": { "name": "List All Flow Paths", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/flows/list_paths", "params": [ { "name": "workspace", "value": "", "type": "path" } ] }, "docs": "List All Flow Paths" }, { "info": { "name": "List Flows for Search", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/flows/list_search", "params": [ { "name": "workspace", "value": "", "type": "path" } ] }, "docs": "List Flows for Search" }, { "info": { "name": "List All Flows", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/flows/list", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query", "description": "which page to return (start at 1, default 1)" }, { "name": "per_page", "value": "", "type": "query", "description": "number of items to return for a given page (default 30, max 100)" }, { "name": "order_desc", "value": "", "type": "query", "description": "order by desc order (default true)" }, { "name": "created_by", "value": "", "type": "query", "description": "filter by exact matching user creator. Supports comma-separated list (e.g. 'alice,bob') and negation by prefixing all values with '!' (e.g. '!alice,!bob')" }, { "name": "path_start", "value": "", "type": "query", "description": "mask to filter matching starting path" }, { "name": "path_exact", "value": "", "type": "query", "description": "mask to filter exact matching path" }, { "name": "show_archived", "value": "", "type": "query", "description": "(default false)\nshow only the archived files.\nwhen multiple archived hash share the same path, only the ones with the latest create_at\nare displayed.\n" }, { "name": "starred_only", "value": "", "type": "query", "description": "(default false)\nshow only the starred items\n" }, { "name": "include_draft_only", "value": "", "type": "query", "description": "(default false)\ninclude items that have no deployed version\n" }, { "name": "with_deployment_msg", "value": "", "type": "query", "description": "(default false)\ninclude deployment message\n" }, { "name": "without_description", "value": "", "type": "query", "description": "(default false)\nIf true, the description field will be omitted from the response.\n" }, { "name": "dedicated_worker", "value": "", "type": "query", "description": "(default regardless)\nIf true, show only flows with dedicated_worker enabled.\nIf false, show only flows with dedicated_worker disabled.\n" }, { "name": "label", "value": "", "type": "query", "description": "Filter by label" } ] }, "docs": "List All Flows" }, { "info": { "name": "Get Flow History by Path", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/flows/history/p/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "Get Flow History by Path" }, { "info": { "name": "Get Flow's Latest Version", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/flows/get_latest_version/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "Get Flow's Latest Version" }, { "info": { "name": "List Flow Paths from Workspace Runnable", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/flows/list_paths_from_workspace_runnable/:runnable_kind/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "runnable_kind", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" }, { "name": "match_path_start", "value": "", "type": "query" } ] }, "docs": "List Flow Paths from Workspace Runnable" }, { "info": { "name": "Get Flow Version", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/flows/get/v/:version", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "version", "value": "", "type": "path" } ] }, "docs": "Get Flow Version" }, { "info": { "name": "Update Flow History", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/flows/history_update/v/:version", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "version", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update Flow History" }, { "info": { "name": "Get Flow by Path", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/flows/get/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" }, { "name": "with_starred_info", "value": "", "type": "query" } ] }, "docs": "Get Flow by Path" }, { "info": { "name": "Get Flow Deployment Status", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/flows/deployment_status/p/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "Get Flow Deployment Status" }, { "info": { "name": "Get Triggers Count of Flow", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/flows/get_triggers_count/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "Get Triggers Count of Flow" }, { "info": { "name": "Get Tokens with Flow Scope", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/flows/list_tokens/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "Get Tokens with Flow Scope" }, { "info": { "name": "Toggle ON and OFF the Workspace Error Handler for a Given Flow", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/flows/toggle_workspace_error_handler/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Toggle ON and OFF the Workspace Error Handler for a Given Flow" }, { "info": { "name": "Get Flow by Path with Draft", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/flows/get/draft/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "Get Flow by Path with Draft" }, { "info": { "name": "Exists Flow by Path", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/flows/exists/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "Exists Flow by Path" }, { "info": { "name": "Create Flow", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/flows/create", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create Flow" }, { "info": { "name": "Update Flow", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/flows/update/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update Flow" }, { "info": { "name": "Archive Flow by Path", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/flows/archive/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Archive Flow by Path" }, { "info": { "name": "Delete Flow by Path", "type": "http" }, "http": { "method": "DELETE", "url": "/api/w/:workspace/flows/delete/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" }, { "name": "keep_captures", "value": "", "type": "query", "description": "keep captures" } ] }, "docs": "Delete Flow by Path" } ] }, { "info": { "name": "app", "type": "folder" }, "items": [ { "info": { "name": "List All Hub Apps", "type": "http" }, "http": { "method": "GET", "url": "/api/apps/hub/list" }, "docs": "List All Hub Apps" }, { "info": { "name": "Get Hub App by Id", "type": "http" }, "http": { "method": "GET", "url": "/api/apps/hub/get/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get Hub App by Id" }, { "info": { "name": "Get Hub Raw App by Id", "type": "http" }, "http": { "method": "GET", "url": "/api/apps/hub/get_raw/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get Hub Raw App by Id" }, { "info": { "name": "Get Public App by Custom Path", "type": "http" }, "http": { "method": "GET", "url": "/api/apps_u/public_app_by_custom_path/:custom_path", "params": [ { "name": "custom_path", "value": "", "type": "path" } ] }, "docs": "Get Public App by Custom Path" }, { "info": { "name": "Get Raw App Data by", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/apps/get_data/v/:secretWithExtension", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "secretWithExtension", "value": "", "type": "path" } ] }, "docs": "Get Raw App Data by" }, { "info": { "name": "List Apps for Search", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/apps/list_search", "params": [ { "name": "workspace", "value": "", "type": "path" } ] }, "docs": "List Apps for Search" }, { "info": { "name": "List All Apps", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/apps/list", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query", "description": "which page to return (start at 1, default 1)" }, { "name": "per_page", "value": "", "type": "query", "description": "number of items to return for a given page (default 30, max 100)" }, { "name": "order_desc", "value": "", "type": "query", "description": "order by desc order (default true)" }, { "name": "created_by", "value": "", "type": "query", "description": "filter by exact matching user creator. Supports comma-separated list (e.g. 'alice,bob') and negation by prefixing all values with '!' (e.g. '!alice,!bob')" }, { "name": "path_start", "value": "", "type": "query", "description": "mask to filter matching starting path" }, { "name": "path_exact", "value": "", "type": "query", "description": "mask to filter exact matching path" }, { "name": "starred_only", "value": "", "type": "query", "description": "(default false)\nshow only the starred items\n" }, { "name": "include_draft_only", "value": "", "type": "query", "description": "(default false)\ninclude items that have no deployed version\n" }, { "name": "with_deployment_msg", "value": "", "type": "query", "description": "(default false)\ninclude deployment message\n" }, { "name": "label", "value": "", "type": "query", "description": "Filter by label" } ] }, "docs": "List All Apps" }, { "info": { "name": "Create App", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/apps/create", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create App" }, { "info": { "name": "Create App Raw", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/apps/create_raw", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "multipart-form", "data": [ { "name": "app", "type": "text", "value": "" }, { "name": "js", "type": "text", "value": "" }, { "name": "css", "type": "text", "value": "" } ] } }, "docs": "Create App Raw" }, { "info": { "name": "Does an App Exisst at Path", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/apps/exists/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "Does an App Exisst at Path" }, { "info": { "name": "Get App by Path", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/apps/get/p/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" }, { "name": "with_starred_info", "value": "", "type": "query" } ] }, "docs": "Get App by Path" }, { "info": { "name": "Get App Lite by Path", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/apps/get/lite/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "Get App Lite by Path" }, { "info": { "name": "Get App by Path with Draft", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/apps/get/draft/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "Get App by Path with Draft" }, { "info": { "name": "Get App History by Path", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/apps/history/p/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "Get App History by Path" }, { "info": { "name": "Get Apps's Latest Version", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/apps/get_latest_version/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "Get Apps's Latest Version" }, { "info": { "name": "List App Paths from Workspace Runnable", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/apps/list_paths_from_workspace_runnable/:runnable_kind/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "runnable_kind", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "List App Paths from Workspace Runnable" }, { "info": { "name": "Update App History", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/apps/history_update/a/:id/v/:version", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" }, { "name": "version", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update App History" }, { "info": { "name": "Get Public App by Secret", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/apps_u/public_app/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "Get Public App by Secret" }, { "info": { "name": "Get Public Resource", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/apps_u/public_resource/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "Get Public Resource" }, { "info": { "name": "Get Public Secret of App", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/apps/secret_of/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "Get Public Secret of App" }, { "info": { "name": "Get Public Secret of Latest Version of an App Bundle", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/apps/secret_of_latest_version/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "Get Public Secret of Latest Version of an App Bundle" }, { "info": { "name": "Get App by Version", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/apps/get/v/:id", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get App by Version" }, { "info": { "name": "Delete App", "type": "http" }, "http": { "method": "DELETE", "url": "/api/w/:workspace/apps/delete/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "Delete App" }, { "info": { "name": "Update App", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/apps/update/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update App" }, { "info": { "name": "Update App", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/apps/update_raw/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ], "body": { "type": "multipart-form", "data": [ { "name": "app", "type": "text", "value": "" }, { "name": "js", "type": "text", "value": "" }, { "name": "css", "type": "text", "value": "" } ] } }, "docs": "Update App" }, { "info": { "name": "Check if Custom Path Exists", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/apps/custom_path_exists/:custom_path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "custom_path", "value": "", "type": "path" } ] }, "docs": "Check if Custom Path Exists" }, { "info": { "name": "Sign S3 Objects, to be Used by Anonymous Users in Public Apps", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/apps/sign_s3_objects", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Sign S3 Objects, to be Used by Anonymous Users in Public Apps" }, { "info": { "name": "ExecuteComponent", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/apps_u/execute_component/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "ExecuteComponent" }, { "info": { "name": "Upload S3 File from App", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/apps_u/upload_s3_file/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" }, { "name": "file_key", "value": "", "type": "query" }, { "name": "file_extension", "value": "", "type": "query" }, { "name": "s3_resource_path", "value": "", "type": "query" }, { "name": "resource_type", "value": "", "type": "query" }, { "name": "storage", "value": "", "type": "query" }, { "name": "content_type", "value": "", "type": "query" }, { "name": "content_disposition", "value": "", "type": "query" } ] }, "docs": "Upload S3 File from App" }, { "info": { "name": "Delete S3 File from App", "type": "http" }, "http": { "method": "DELETE", "url": "/api/w/:workspace/apps_u/delete_s3_file", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "delete_token", "value": "", "type": "query" } ] }, "docs": "Delete S3 File from App" } ] }, { "info": { "name": "script", "type": "folder" }, "items": [ { "info": { "name": "Get Hub Script Content by Path", "type": "http" }, "http": { "method": "GET", "url": "/api/scripts/hub/get/:path", "params": [ { "name": "path", "value": "", "type": "path" } ] }, "docs": "Get Hub Script Content by Path" }, { "info": { "name": "Get Full Hub Script by Path", "type": "http" }, "http": { "method": "GET", "url": "/api/scripts/hub/get_full/:path", "params": [ { "name": "path", "value": "", "type": "path" } ] }, "docs": "Get Full Hub Script by Path" }, { "info": { "name": "Record Hub Script Pick", "type": "http" }, "http": { "method": "GET", "url": "/api/scripts/hub/pick/:path", "params": [ { "name": "path", "value": "", "type": "path" } ] }, "docs": "Record Hub Script Pick" }, { "info": { "name": "Get Top Hub Scripts", "type": "http" }, "http": { "method": "GET", "url": "/api/scripts/hub/top", "params": [ { "name": "limit", "value": "", "type": "query", "description": "query limit" }, { "name": "app", "value": "", "type": "query", "description": "query scripts app" }, { "name": "kind", "value": "", "type": "query", "description": "query scripts kind" } ] }, "docs": "Get Top Hub Scripts" }, { "info": { "name": "Query Hub Scripts by Similarity", "type": "http" }, "http": { "method": "GET", "url": "/api/embeddings/query_hub_scripts", "params": [ { "name": "text", "value": "", "type": "query", "description": "query text" }, { "name": "kind", "value": "", "type": "query", "description": "query scripts kind" }, { "name": "limit", "value": "", "type": "query", "description": "query limit" }, { "name": "app", "value": "", "type": "query", "description": "query scripts app" } ] }, "docs": "Query Hub Scripts by Similarity" }, { "info": { "name": "List Scripts for Search", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/scripts/list_search", "params": [ { "name": "workspace", "value": "", "type": "path" } ] }, "docs": "List Scripts for Search" }, { "info": { "name": "List All Scripts", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/scripts/list", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query", "description": "which page to return (start at 1, default 1)" }, { "name": "per_page", "value": "", "type": "query", "description": "number of items to return for a given page (default 30, max 100)" }, { "name": "order_desc", "value": "", "type": "query", "description": "order by desc order (default true)" }, { "name": "created_by", "value": "", "type": "query", "description": "filter by exact matching user creator. Supports comma-separated list (e.g. 'alice,bob') and negation by prefixing all values with '!' (e.g. '!alice,!bob')" }, { "name": "path_start", "value": "", "type": "query", "description": "mask to filter matching starting path" }, { "name": "path_exact", "value": "", "type": "query", "description": "mask to filter exact matching path" }, { "name": "first_parent_hash", "value": "", "type": "query", "description": "mask to filter scripts whom first direct parent has exact hash" }, { "name": "last_parent_hash", "value": "", "type": "query", "description": "mask to filter scripts whom last parent in the chain has exact hash.\nBeware that each script stores only a limited number of parents. Hence\nthe last parent hash for a script is not necessarily its top-most parent.\nTo find the top-most parent you will have to jump from last to last hash\n until finding the parent\n" }, { "name": "parent_hash", "value": "", "type": "query", "description": "is the hash present in the array of stored parent hashes for this script.\nThe same warning applies than for last_parent_hash. A script only store a\nlimited number of direct parent\n" }, { "name": "show_archived", "value": "", "type": "query", "description": "(default false)\nshow only the archived files.\nwhen multiple archived hash share the same path, only the ones with the latest create_at\nare\ned.\n" }, { "name": "include_without_main", "value": "", "type": "query", "description": "(default false)\ninclude scripts without an exported main function\n" }, { "name": "include_draft_only", "value": "", "type": "query", "description": "(default false)\ninclude scripts that have no deployed version\n" }, { "name": "is_template", "value": "", "type": "query", "description": "(default regardless)\nif true show only the templates\nif false show only the non templates\nif not defined, show all regardless of if the script is a template\n" }, { "name": "kinds", "value": "", "type": "query", "description": "(default regardless)\nscript kinds to filter, split by comma\n" }, { "name": "starred_only", "value": "", "type": "query", "description": "(default false)\nshow only the starred items\n" }, { "name": "with_deployment_msg", "value": "", "type": "query", "description": "(default false)\ninclude deployment message\n" }, { "name": "languages", "value": "", "type": "query", "description": "Filter to only include scripts written in the given languages.\nAccepts multiple values as a comma-separated list.\n" }, { "name": "without_description", "value": "", "type": "query", "description": "(default false)\nIf true, the description field will be omitted from the response.\n" }, { "name": "dedicated_worker", "value": "", "type": "query", "description": "(default regardless)\nIf true, show only scripts with dedicated_worker enabled.\nIf false, show only scripts with dedicated_worker disabled.\n" }, { "name": "label", "value": "", "type": "query", "description": "Filter by label" } ] }, "docs": "List All Scripts" }, { "info": { "name": "List All Scripts Paths", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/scripts/list_paths", "params": [ { "name": "workspace", "value": "", "type": "path" } ] }, "docs": "List All Scripts Paths" }, { "info": { "name": "Create Script", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/scripts/create", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new script when the path does not already exist.\nCreates a new version of an existing script when called with the same path and the current `parent_hash`.\n" }, { "info": { "name": "Toggle ON and OFF the Workspace Error Handler for a Given Script", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/scripts/toggle_workspace_error_handler/p/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Toggle ON and OFF the Workspace Error Handler for a Given Script" }, { "info": { "name": "Archive Script by Path", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/scripts/archive/p/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "Archive Script by Path" }, { "info": { "name": "Archive Script by Hash", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/scripts/archive/h/:hash", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "hash", "value": "", "type": "path" } ] }, "docs": "Archive Script by Hash" }, { "info": { "name": "Delete Script by Hash (erase Content but Keep Hash, Require Admin)", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/scripts/delete/h/:hash", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "hash", "value": "", "type": "path" } ] }, "docs": "Delete Script by Hash (erase Content but Keep Hash, Require Admin)" }, { "info": { "name": "Delete Script at a Given Path (require Admin)", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/scripts/delete/p/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" }, { "name": "keep_captures", "value": "", "type": "query", "description": "keep captures" } ] }, "docs": "Delete Script at a Given Path (require Admin)" }, { "info": { "name": "Delete Scripts in Bulk", "type": "http" }, "http": { "method": "DELETE", "url": "/api/w/:workspace/scripts/delete_bulk", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete Scripts in Bulk" }, { "info": { "name": "Get Script by Path", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/scripts/get/p/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" }, { "name": "with_starred_info", "value": "", "type": "query" } ] }, "docs": "Get Script by Path" }, { "info": { "name": "Get Triggers Count of Script", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/scripts/get_triggers_count/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "Get Triggers Count of Script" }, { "info": { "name": "Get Tokens with Script Scope", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/scripts/list_tokens/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "Get Tokens with Script Scope" }, { "info": { "name": "Get Script by Path with Draft", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/scripts/get/draft/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "Get Script by Path with Draft" }, { "info": { "name": "Get History of a Script by Path", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/scripts/history/p/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "Get History of a Script by Path" }, { "info": { "name": "List Script Paths Using Provided Script as a Relative Import", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/scripts/list_paths_from_workspace_runnable/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "List Script Paths Using Provided Script as a Relative Import" }, { "info": { "name": "Get Scripts's Latest Version (hash)", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/scripts/get_latest_version/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "Get Scripts's Latest Version (hash)" }, { "info": { "name": "Update History of a Script", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/scripts/history_update/h/:hash/p/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "hash", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update History of a Script" }, { "info": { "name": "List Dedicated Worker Scripts with Workspace Dependency Annotations", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/scripts/list_dedicated_with_deps", "params": [ { "name": "workspace", "value": "", "type": "path" } ] }, "docs": "List Dedicated Worker Scripts with Workspace Dependency Annotations" }, { "info": { "name": "Raw Script by Path", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/scripts/raw/p/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "Raw Script by Path" }, { "info": { "name": "raw script by path with a token (mostly used by lsp to be used with import maps to resolve scripts)", "type": "http" }, "http": { "method": "GET", "url": "/api/scripts_u/tokened_raw/:workspace/:token/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "token", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "raw script by path with a token (mostly used by lsp to be used with import maps to resolve scripts)" }, { "info": { "name": "Exists Script by Path", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/scripts/exists/p/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "Exists Script by Path" }, { "info": { "name": "Get Script by Hash", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/scripts/get/h/:hash", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "hash", "value": "", "type": "path" }, { "name": "with_starred_info", "value": "", "type": "query" }, { "name": "authed", "value": "", "type": "query" } ] }, "docs": "Get Script by Hash" }, { "info": { "name": "Raw Script by Hash", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/scripts/raw/h/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "Raw Script by Hash" }, { "info": { "name": "Get Script Deployment Status", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/scripts/deployment_status/h/:hash", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "hash", "value": "", "type": "path" } ] }, "docs": "Get Script Deployment Status" }, { "info": { "name": "Get CI Test Results for a Script, Flow, or Resource", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/scripts/ci_test_results/:kind/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "kind", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "Get CI Test Results for a Script, Flow, or Resource" }, { "info": { "name": "Get CI Test Results for Multiple Items", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/scripts/ci_test_results_batch", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Get CI Test Results for Multiple Items" }, { "info": { "name": "Store Raw Script Content Temporarily for CLI Lock Generation", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/scripts/raw_temp/store", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Store Raw Script Content Temporarily for CLI Lock Generation" }, { "info": { "name": "Diff Local Script Hashes Against Deployed Versions", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/scripts/raw_temp/diff", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Diff Local Script Hashes Against Deployed Versions" } ] }, { "info": { "name": "draft", "type": "folder" }, "items": [ { "info": { "name": "Create Draft", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/drafts/create", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create Draft" }, { "info": { "name": "Delete Draft", "type": "http" }, "http": { "method": "DELETE", "url": "/api/w/:workspace/drafts/delete/:kind/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "kind", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "Delete Draft" } ] }, { "info": { "name": "worker", "type": "folder" }, "items": [ { "info": { "name": "Get All Instance Custom Tags (tags are Used to Dispatch Jobs to different worker groups)", "type": "http" }, "http": { "method": "GET", "url": "/api/workers/custom_tags", "params": [ { "name": "show_workspace_restriction", "value": "", "type": "query" } ] }, "docs": "Get All Instance Custom Tags (tags are Used to Dispatch Jobs to different worker groups)" }, { "info": { "name": "Get Custom Tags Available for this Workspace", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/workers/custom_tags", "params": [ { "name": "workspace", "value": "", "type": "path" } ] }, "docs": "Get Custom Tags Available for this Workspace" }, { "info": { "name": "Get All Instance Default Tags", "type": "http" }, "http": { "method": "GET", "url": "/api/workers/get_default_tags" }, "docs": "Get All Instance Default Tags" }, { "info": { "name": "Is Default Tags Per Workspace", "type": "http" }, "http": { "method": "GET", "url": "/api/workers/is_default_tags_per_workspace" }, "docs": "Is Default Tags Per Workspace" }, { "info": { "name": "List Workers", "type": "http" }, "http": { "method": "GET", "url": "/api/workers/list", "params": [ { "name": "page", "value": "", "type": "query", "description": "which page to return (start at 1, default 1)" }, { "name": "per_page", "value": "", "type": "query", "description": "number of items to return for a given page (default 30, max 100)" }, { "name": "ping_since", "value": "", "type": "query", "description": "number of seconds the worker must have had a last ping more recent of (default to 300)" } ] }, "docs": "List Workers" }, { "info": { "name": "Exists Workers with Tags", "type": "http" }, "http": { "method": "GET", "url": "/api/workers/exists_workers_with_tags", "params": [ { "name": "tags", "value": "", "type": "query", "description": "comma separated list of tags" }, { "name": "workspace", "value": "", "type": "query", "description": "workspace to filter tags visibility (required when TAGS_ARE_SENSITIVE is enabled for non-superadmins)" } ] }, "docs": "Exists Workers with Tags" }, { "info": { "name": "Get Queue Metrics", "type": "http" }, "http": { "method": "GET", "url": "/api/workers/queue_metrics" }, "docs": "Get Queue Metrics" }, { "info": { "name": "Get Counts of Jobs Waiting for an Executor Per Tag", "type": "http" }, "http": { "method": "GET", "url": "/api/workers/queue_counts" }, "docs": "Get Counts of Jobs Waiting for an Executor Per Tag" }, { "info": { "name": "Get Counts of Currently Running Jobs Per Tag", "type": "http" }, "http": { "method": "GET", "url": "/api/workers/queue_running_counts" }, "docs": "Get Counts of Currently Running Jobs Per Tag" } ] }, { "info": { "name": "workspace_dependencies", "type": "folder" }, "items": [ { "info": { "name": "Create Workspace Dependencies", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/workspace_dependencies/create", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create Workspace Dependencies" }, { "info": { "name": "Archive Workspace Dependencies (require Admin)", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/workspace_dependencies/archive/:language", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "language", "value": "", "type": "path" }, { "name": "name", "value": "", "type": "query" } ] }, "docs": "Archive Workspace Dependencies (require Admin)" }, { "info": { "name": "Delete Workspace Dependencies (require Admin)", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/workspace_dependencies/delete/:language", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "language", "value": "", "type": "path" }, { "name": "name", "value": "", "type": "query" } ] }, "docs": "Delete Workspace Dependencies (require Admin)" }, { "info": { "name": "List All Workspace Dependencies", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/workspace_dependencies/list", "params": [ { "name": "workspace", "value": "", "type": "path" } ] }, "docs": "List All Workspace Dependencies" }, { "info": { "name": "Get Latest Workspace Dependencies by Language and Name", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/workspace_dependencies/get_latest/:language", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "language", "value": "", "type": "path" }, { "name": "name", "value": "", "type": "query" } ] }, "docs": "Get Latest Workspace Dependencies by Language and Name" } ] }, { "info": { "name": "job", "type": "folder" }, "items": [ { "info": { "name": "List Selected Jobs Script/flow Schemas Grouped by (kind, Path)", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/jobs/list_selected_job_groups", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "List Selected Jobs Script/flow Schemas Grouped by (kind, Path)" }, { "info": { "name": "Run Script by Path", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/jobs/run/p/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" }, { "name": "scheduled_for", "value": "", "type": "query", "description": "when to schedule this job (leave empty for immediate run)" }, { "name": "scheduled_in_secs", "value": "", "type": "query", "description": "schedule the script to execute in the number of seconds starting now" }, { "name": "skip_preprocessor", "value": "", "type": "query", "description": "skip the preprocessor" }, { "name": "parent_job", "value": "", "type": "query", "description": "The parent job that is at the origin and responsible for the execution of this script if any" }, { "name": "tag", "value": "", "type": "query", "description": "Override the tag to use" }, { "name": "cache_ttl", "value": "", "type": "query", "description": "Override the cache time to live (in seconds). Can not be used to disable caching, only override with a new cache ttl" }, { "name": "job_id", "value": "", "type": "query", "description": "The job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)" }, { "name": "invisible_to_owner", "value": "", "type": "query", "description": "make the run invisible to the the script owner (default false)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Run Script by Path" }, { "info": { "name": "Run Script by Path with Get", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/jobs/run_wait_result/p/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" }, { "name": "parent_job", "value": "", "type": "query", "description": "The parent job that is at the origin and responsible for the execution of this script if any" }, { "name": "tag", "value": "", "type": "query", "description": "Override the tag to use" }, { "name": "cache_ttl", "value": "", "type": "query", "description": "Override the cache time to live (in seconds). Can not be used to disable caching, only override with a new cache ttl" }, { "name": "job_id", "value": "", "type": "query", "description": "The job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)" }, { "name": "include_header", "value": "", "type": "query", "description": "List of headers's keys (separated with ',') whove value are added to the args\nHeader's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key\n" }, { "name": "queue_limit", "value": "", "type": "query", "description": "The maximum size of the queue for which the request would get rejected if that job would push it above that limit\n" }, { "name": "payload", "value": "", "type": "query", "description": "The base64 encoded payload that has been encoded as a JSON. e.g how to encode such payload encodeURIComponent\n`encodeURIComponent(btoa(JSON.stringify({a: 2})))`\n" }, { "name": "skip_preprocessor", "value": "", "type": "query", "description": "skip the preprocessor" } ] }, "docs": "Run Script by Path with Get" }, { "info": { "name": "Run Script by Path", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/jobs/run_wait_result/p/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" }, { "name": "parent_job", "value": "", "type": "query", "description": "The parent job that is at the origin and responsible for the execution of this script if any" }, { "name": "tag", "value": "", "type": "query", "description": "Override the tag to use" }, { "name": "cache_ttl", "value": "", "type": "query", "description": "Override the cache time to live (in seconds). Can not be used to disable caching, only override with a new cache ttl" }, { "name": "job_id", "value": "", "type": "query", "description": "The job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)" }, { "name": "include_header", "value": "", "type": "query", "description": "List of headers's keys (separated with ',') whove value are added to the args\nHeader's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key\n" }, { "name": "queue_limit", "value": "", "type": "query", "description": "The maximum size of the queue for which the request would get rejected if that job would push it above that limit\n" }, { "name": "skip_preprocessor", "value": "", "type": "query", "description": "skip the preprocessor" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Run Script by Path" }, { "info": { "name": "Run Flow by Path and Wait Until Completion", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/jobs/run_wait_result/f/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" }, { "name": "include_header", "value": "", "type": "query", "description": "List of headers's keys (separated with ',') whove value are added to the args\nHeader's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key\n" }, { "name": "queue_limit", "value": "", "type": "query", "description": "The maximum size of the queue for which the request would get rejected if that job would push it above that limit\n" }, { "name": "job_id", "value": "", "type": "query", "description": "The job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)" }, { "name": "skip_preprocessor", "value": "", "type": "query", "description": "skip the preprocessor" }, { "name": "memory_id", "value": "", "type": "query", "description": "memory ID for chat-enabled flows" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Run Flow by Path and Wait Until Completion" }, { "info": { "name": "Run Flow by Version with GET and Wait Until Completion", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/jobs/run_wait_result/fv/:version", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "version", "value": "", "type": "path", "description": "flow version ID" }, { "name": "include_header", "value": "", "type": "query", "description": "List of headers's keys (separated with ',') whove value are added to the args\nHeader's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key\n" }, { "name": "queue_limit", "value": "", "type": "query", "description": "The maximum size of the queue for which the request would get rejected if that job would push it above that limit\n" }, { "name": "payload", "value": "", "type": "query", "description": "The base64 encoded payload that has been encoded as a JSON. e.g how to encode such payload encodeURIComponent\n`encodeURIComponent(btoa(JSON.stringify({a: 2})))`\n" }, { "name": "job_id", "value": "", "type": "query", "description": "The job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)" }, { "name": "skip_preprocessor", "value": "", "type": "query", "description": "skip the preprocessor" }, { "name": "memory_id", "value": "", "type": "query", "description": "memory ID for chat-enabled flows" } ] }, "docs": "Run Flow by Version with GET and Wait Until Completion" }, { "info": { "name": "Run Flow by Version and Wait Until Completion", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/jobs/run_wait_result/fv/:version", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "version", "value": "", "type": "path", "description": "flow version ID" }, { "name": "include_header", "value": "", "type": "query", "description": "List of headers's keys (separated with ',') whove value are added to the args\nHeader's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key\n" }, { "name": "queue_limit", "value": "", "type": "query", "description": "The maximum size of the queue for which the request would get rejected if that job would push it above that limit\n" }, { "name": "job_id", "value": "", "type": "query", "description": "The job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)" }, { "name": "skip_preprocessor", "value": "", "type": "query", "description": "skip the preprocessor" }, { "name": "memory_id", "value": "", "type": "query", "description": "memory ID for chat-enabled flows" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Run Flow by Version and Wait Until Completion" }, { "info": { "name": "Run Flow by Path with GET and Stream Updates via SSE", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/jobs/run_and_stream/f/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" }, { "name": "include_header", "value": "", "type": "query", "description": "List of headers's keys (separated with ',') whove value are added to the args\nHeader's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key\n" }, { "name": "queue_limit", "value": "", "type": "query", "description": "The maximum size of the queue for which the request would get rejected if that job would push it above that limit\n" }, { "name": "payload", "value": "", "type": "query", "description": "The base64 encoded payload that has been encoded as a JSON. e.g how to encode such payload encodeURIComponent\n`encodeURIComponent(btoa(JSON.stringify({a: 2})))`\n" }, { "name": "job_id", "value": "", "type": "query", "description": "The job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)" }, { "name": "skip_preprocessor", "value": "", "type": "query", "description": "skip the preprocessor" }, { "name": "memory_id", "value": "", "type": "query", "description": "memory ID for chat-enabled flows" }, { "name": "poll_delay_ms", "value": "", "type": "query", "description": "delay between polling for job updates in milliseconds" } ] }, "docs": "Run Flow by Path with GET and Stream Updates via SSE" }, { "info": { "name": "Run Flow by Path and Stream Updates via SSE", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/jobs/run_and_stream/f/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" }, { "name": "include_header", "value": "", "type": "query", "description": "List of headers's keys (separated with ',') whove value are added to the args\nHeader's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key\n" }, { "name": "queue_limit", "value": "", "type": "query", "description": "The maximum size of the queue for which the request would get rejected if that job would push it above that limit\n" }, { "name": "job_id", "value": "", "type": "query", "description": "The job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)" }, { "name": "skip_preprocessor", "value": "", "type": "query", "description": "skip the preprocessor" }, { "name": "memory_id", "value": "", "type": "query", "description": "memory ID for chat-enabled flows" }, { "name": "poll_delay_ms", "value": "", "type": "query", "description": "delay between polling for job updates in milliseconds" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Run Flow by Path and Stream Updates via SSE" }, { "info": { "name": "Run Flow by Version with GET and Stream Updates via SSE", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/jobs/run_and_stream/fv/:version", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "version", "value": "", "type": "path", "description": "flow version ID" }, { "name": "include_header", "value": "", "type": "query", "description": "List of headers's keys (separated with ',') whove value are added to the args\nHeader's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key\n" }, { "name": "queue_limit", "value": "", "type": "query", "description": "The maximum size of the queue for which the request would get rejected if that job would push it above that limit\n" }, { "name": "payload", "value": "", "type": "query", "description": "The base64 encoded payload that has been encoded as a JSON. e.g how to encode such payload encodeURIComponent\n`encodeURIComponent(btoa(JSON.stringify({a: 2})))`\n" }, { "name": "job_id", "value": "", "type": "query", "description": "The job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)" }, { "name": "skip_preprocessor", "value": "", "type": "query", "description": "skip the preprocessor" }, { "name": "memory_id", "value": "", "type": "query", "description": "memory ID for chat-enabled flows" }, { "name": "poll_delay_ms", "value": "", "type": "query", "description": "delay between polling for job updates in milliseconds" } ] }, "docs": "Run Flow by Version with GET and Stream Updates via SSE" }, { "info": { "name": "Run Flow by Version and Stream Updates via SSE", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/jobs/run_and_stream/fv/:version", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "version", "value": "", "type": "path", "description": "flow version ID" }, { "name": "include_header", "value": "", "type": "query", "description": "List of headers's keys (separated with ',') whove value are added to the args\nHeader's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key\n" }, { "name": "queue_limit", "value": "", "type": "query", "description": "The maximum size of the queue for which the request would get rejected if that job would push it above that limit\n" }, { "name": "job_id", "value": "", "type": "query", "description": "The job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)" }, { "name": "skip_preprocessor", "value": "", "type": "query", "description": "skip the preprocessor" }, { "name": "memory_id", "value": "", "type": "query", "description": "memory ID for chat-enabled flows" }, { "name": "poll_delay_ms", "value": "", "type": "query", "description": "delay between polling for job updates in milliseconds" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Run Flow by Version and Stream Updates via SSE" }, { "info": { "name": "Run Script by Path with GET and Stream Updates via SSE", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/jobs/run_and_stream/p/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" }, { "name": "parent_job", "value": "", "type": "query", "description": "The parent job that is at the origin and responsible for the execution of this script if any" }, { "name": "tag", "value": "", "type": "query", "description": "Override the tag to use" }, { "name": "cache_ttl", "value": "", "type": "query", "description": "Override the cache time to live (in seconds). Can not be used to disable caching, only override with a new cache ttl" }, { "name": "job_id", "value": "", "type": "query", "description": "The job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)" }, { "name": "include_header", "value": "", "type": "query", "description": "List of headers's keys (separated with ',') whove value are added to the args\nHeader's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key\n" }, { "name": "queue_limit", "value": "", "type": "query", "description": "The maximum size of the queue for which the request would get rejected if that job would push it above that limit\n" }, { "name": "payload", "value": "", "type": "query", "description": "The base64 encoded payload that has been encoded as a JSON. e.g how to encode such payload encodeURIComponent\n`encodeURIComponent(btoa(JSON.stringify({a: 2})))`\n" }, { "name": "skip_preprocessor", "value": "", "type": "query", "description": "skip the preprocessor" }, { "name": "poll_delay_ms", "value": "", "type": "query", "description": "delay between polling for job updates in milliseconds" } ] }, "docs": "Run Script by Path with GET and Stream Updates via SSE" }, { "info": { "name": "Run Script by Path and Stream Updates via SSE", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/jobs/run_and_stream/p/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" }, { "name": "parent_job", "value": "", "type": "query", "description": "The parent job that is at the origin and responsible for the execution of this script if any" }, { "name": "tag", "value": "", "type": "query", "description": "Override the tag to use" }, { "name": "cache_ttl", "value": "", "type": "query", "description": "Override the cache time to live (in seconds). Can not be used to disable caching, only override with a new cache ttl" }, { "name": "job_id", "value": "", "type": "query", "description": "The job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)" }, { "name": "include_header", "value": "", "type": "query", "description": "List of headers's keys (separated with ',') whove value are added to the args\nHeader's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key\n" }, { "name": "queue_limit", "value": "", "type": "query", "description": "The maximum size of the queue for which the request would get rejected if that job would push it above that limit\n" }, { "name": "skip_preprocessor", "value": "", "type": "query", "description": "skip the preprocessor" }, { "name": "poll_delay_ms", "value": "", "type": "query", "description": "delay between polling for job updates in milliseconds" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Run Script by Path and Stream Updates via SSE" }, { "info": { "name": "Run Script by Hash with GET and Stream Updates via SSE", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/jobs/run_and_stream/h/:hash", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "hash", "value": "", "type": "path" }, { "name": "parent_job", "value": "", "type": "query", "description": "The parent job that is at the origin and responsible for the execution of this script if any" }, { "name": "tag", "value": "", "type": "query", "description": "Override the tag to use" }, { "name": "cache_ttl", "value": "", "type": "query", "description": "Override the cache time to live (in seconds). Can not be used to disable caching, only override with a new cache ttl" }, { "name": "job_id", "value": "", "type": "query", "description": "The job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)" }, { "name": "include_header", "value": "", "type": "query", "description": "List of headers's keys (separated with ',') whove value are added to the args\nHeader's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key\n" }, { "name": "queue_limit", "value": "", "type": "query", "description": "The maximum size of the queue for which the request would get rejected if that job would push it above that limit\n" }, { "name": "payload", "value": "", "type": "query", "description": "The base64 encoded payload that has been encoded as a JSON. e.g how to encode such payload encodeURIComponent\n`encodeURIComponent(btoa(JSON.stringify({a: 2})))`\n" }, { "name": "skip_preprocessor", "value": "", "type": "query", "description": "skip the preprocessor" }, { "name": "poll_delay_ms", "value": "", "type": "query", "description": "delay between polling for job updates in milliseconds" } ] }, "docs": "Run Script by Hash with GET and Stream Updates via SSE" }, { "info": { "name": "Run Script by Hash and Stream Updates via SSE", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/jobs/run_and_stream/h/:hash", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "hash", "value": "", "type": "path" }, { "name": "parent_job", "value": "", "type": "query", "description": "The parent job that is at the origin and responsible for the execution of this script if any" }, { "name": "tag", "value": "", "type": "query", "description": "Override the tag to use" }, { "name": "cache_ttl", "value": "", "type": "query", "description": "Override the cache time to live (in seconds). Can not be used to disable caching, only override with a new cache ttl" }, { "name": "job_id", "value": "", "type": "query", "description": "The job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)" }, { "name": "include_header", "value": "", "type": "query", "description": "List of headers's keys (separated with ',') whove value are added to the args\nHeader's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key\n" }, { "name": "queue_limit", "value": "", "type": "query", "description": "The maximum size of the queue for which the request would get rejected if that job would push it above that limit\n" }, { "name": "skip_preprocessor", "value": "", "type": "query", "description": "skip the preprocessor" }, { "name": "poll_delay_ms", "value": "", "type": "query", "description": "delay between polling for job updates in milliseconds" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Run Script by Hash and Stream Updates via SSE" }, { "info": { "name": "Get Job Result by Id", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/jobs/result_by_id/:flow_job_id/:node_id", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "flow_job_id", "value": "", "type": "path" }, { "name": "node_id", "value": "", "type": "path" } ] }, "docs": "Get Job Result by Id" }, { "info": { "name": "Run Flow by Path", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/jobs/run/f/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" }, { "name": "scheduled_for", "value": "", "type": "query", "description": "when to schedule this job (leave empty for immediate run)" }, { "name": "scheduled_in_secs", "value": "", "type": "query", "description": "schedule the script to execute in the number of seconds starting now" }, { "name": "skip_preprocessor", "value": "", "type": "query", "description": "skip the preprocessor" }, { "name": "parent_job", "value": "", "type": "query", "description": "The parent job that is at the origin and responsible for the execution of this script if any" }, { "name": "tag", "value": "", "type": "query", "description": "Override the tag to use" }, { "name": "job_id", "value": "", "type": "query", "description": "The job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)" }, { "name": "include_header", "value": "", "type": "query", "description": "List of headers's keys (separated with ',') whove value are added to the args\nHeader's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key\n" }, { "name": "invisible_to_owner", "value": "", "type": "query", "description": "make the run invisible to the the flow owner (default false)" }, { "name": "memory_id", "value": "", "type": "query", "description": "memory ID for chat-enabled flows" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Run Flow by Path" }, { "info": { "name": "Run Flow by Version", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/jobs/run/fv/:version", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "version", "value": "", "type": "path", "description": "flow version ID" }, { "name": "scheduled_for", "value": "", "type": "query", "description": "when to schedule this job (leave empty for immediate run)" }, { "name": "scheduled_in_secs", "value": "", "type": "query", "description": "schedule the script to execute in the number of seconds starting now" }, { "name": "skip_preprocessor", "value": "", "type": "query", "description": "skip the preprocessor" }, { "name": "parent_job", "value": "", "type": "query", "description": "The parent job that is at the origin and responsible for the execution of this script if any" }, { "name": "tag", "value": "", "type": "query", "description": "Override the tag to use" }, { "name": "job_id", "value": "", "type": "query", "description": "The job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)" }, { "name": "include_header", "value": "", "type": "query", "description": "List of headers's keys (separated with ',') whove value are added to the args\nHeader's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key\n" }, { "name": "invisible_to_owner", "value": "", "type": "query", "description": "make the run invisible to the the flow owner (default false)" }, { "name": "memory_id", "value": "", "type": "query", "description": "memory ID for chat-enabled flows" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Run Flow by Version" }, { "info": { "name": "Re-run Multiple Jobs", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/jobs/run/batch_rerun_jobs", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Re-run Multiple Jobs" }, { "info": { "name": "Restart a Completed Flow at a Given Step", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/jobs/restart/f/:id", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" }, { "name": "scheduled_for", "value": "", "type": "query", "description": "when to schedule this job (leave empty for immediate run)" }, { "name": "scheduled_in_secs", "value": "", "type": "query", "description": "schedule the script to execute in the number of seconds starting now" }, { "name": "parent_job", "value": "", "type": "query", "description": "The parent job that is at the origin and responsible for the execution of this script if any" }, { "name": "tag", "value": "", "type": "query", "description": "Override the tag to use" }, { "name": "job_id", "value": "", "type": "query", "description": "The job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)" }, { "name": "include_header", "value": "", "type": "query", "description": "List of headers's keys (separated with ',') whove value are added to the args\nHeader's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key\n" }, { "name": "invisible_to_owner", "value": "", "type": "query", "description": "make the run invisible to the the flow owner (default false)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Restart a Completed Flow at a Given Step" }, { "info": { "name": "Run Script by Hash", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/jobs/run/h/:hash", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "hash", "value": "", "type": "path" }, { "name": "scheduled_for", "value": "", "type": "query", "description": "when to schedule this job (leave empty for immediate run)" }, { "name": "scheduled_in_secs", "value": "", "type": "query", "description": "schedule the script to execute in the number of seconds starting now" }, { "name": "skip_preprocessor", "value": "", "type": "query", "description": "skip the preprocessor" }, { "name": "parent_job", "value": "", "type": "query", "description": "The parent job that is at the origin and responsible for the execution of this script if any" }, { "name": "tag", "value": "", "type": "query", "description": "Override the tag to use" }, { "name": "cache_ttl", "value": "", "type": "query", "description": "Override the cache time to live (in seconds). Can not be used to disable caching, only override with a new cache ttl" }, { "name": "job_id", "value": "", "type": "query", "description": "The job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)" }, { "name": "include_header", "value": "", "type": "query", "description": "List of headers's keys (separated with ',') whove value are added to the args\nHeader's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key\n" }, { "name": "invisible_to_owner", "value": "", "type": "query", "description": "make the run invisible to the the script owner (default false)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Run Script by Hash" }, { "info": { "name": "Run Script Preview", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/jobs/run/preview", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "include_header", "value": "", "type": "query", "description": "List of headers's keys (separated with ',') whove value are added to the args\nHeader's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key\n" }, { "name": "invisible_to_owner", "value": "", "type": "query", "description": "make the run invisible to the the script owner (default false)" }, { "name": "job_id", "value": "", "type": "query", "description": "The job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Run Script Preview" }, { "info": { "name": "Run Script Preview Without Starting a New Job", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/jobs/run_inline/preview", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Run Script Preview Without Starting a New Job" }, { "info": { "name": "Run Script by Path Without Starting a New Job", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/jobs/run_inline/p/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Run Script by Path Without Starting a New Job" }, { "info": { "name": "Run Script by Hash Without Starting a New Job", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/jobs/run_inline/h/:hash", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "hash", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Run Script by Hash Without Starting a New Job" }, { "info": { "name": "Run Script Preview and Wait for Result", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/jobs/run_wait_result/preview", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Run Script Preview and Wait for Result" }, { "info": { "name": "Run Code-workflow Task", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/jobs/workflow_as_code/:job_id/:entrypoint", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "job_id", "value": "", "type": "path" }, { "name": "entrypoint", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Run Code-workflow Task" }, { "info": { "name": "Run a One-off Dependencies Job", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/jobs/run/dependencies", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Run a One-off Dependencies Job" }, { "info": { "name": "Queue a One-off Dependencies Job and Return the Job Uuid", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/jobs/run/dependencies_async", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Queue a One-off Dependencies Job and Return the Job Uuid" }, { "info": { "name": "Queue a One-off Flow Dependencies Job and Return the Job Uuid", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/jobs/run/flow_dependencies_async", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Queue a One-off Flow Dependencies Job and Return the Job Uuid" }, { "info": { "name": "Run Flow Preview", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/jobs/run/preview_flow", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "include_header", "value": "", "type": "query", "description": "List of headers's keys (separated with ',') whove value are added to the args\nHeader's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key\n" }, { "name": "invisible_to_owner", "value": "", "type": "query", "description": "make the run invisible to the the script owner (default false)" }, { "name": "job_id", "value": "", "type": "query", "description": "The job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)" }, { "name": "memory_id", "value": "", "type": "query", "description": "memory ID for chat-enabled flows" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Run Flow Preview" }, { "info": { "name": "Run Flow Preview and Wait for Result", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/jobs/run_wait_result/preview_flow", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "memory_id", "value": "", "type": "query", "description": "memory ID for chat-enabled flows" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Run Flow Preview and Wait for Result" }, { "info": { "name": "Run Dynamic Select Helper Function", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/jobs/run/dynamic_select", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Run Dynamic Select Helper Function" }, { "info": { "name": "List All Queued Jobs", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/jobs/queue/list", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "order_desc", "value": "", "type": "query", "description": "order by desc order (default true)" }, { "name": "created_by", "value": "", "type": "query", "description": "filter by exact matching user creator. Supports comma-separated list (e.g. 'alice,bob') and negation by prefixing all values with '!' (e.g. '!alice,!bob')" }, { "name": "parent_job", "value": "", "type": "query", "description": "The parent job that is at the origin and responsible for the execution of this script if any" }, { "name": "worker", "value": "", "type": "query", "description": "filter by worker this job ran on. Supports comma-separated list (e.g. 'worker-1,worker-2') and negation by prefixing all values with '!' (e.g. '!worker-1,!worker-2')" }, { "name": "script_path_exact", "value": "", "type": "query", "description": "filter by exact matching script path. Supports comma-separated list (e.g. 'f/script1,f/script2') and negation by prefixing all values with '!' (e.g. '!f/script1,!f/script2')" }, { "name": "script_path_start", "value": "", "type": "query", "description": "filter by script path prefix. Supports comma-separated list (e.g. 'f/folder1,f/folder2') and negation by prefixing all values with '!' (e.g. '!f/folder1,!f/folder2')" }, { "name": "schedule_path", "value": "", "type": "query", "description": "mask to filter by schedule path" }, { "name": "trigger_path", "value": "", "type": "query", "description": "filter by trigger path. Supports comma-separated list (e.g. 'f/trigger1,f/trigger2') and negation by prefixing all values with '!' (e.g. '!f/trigger1,!f/trigger2')" }, { "name": "trigger_kind", "value": "", "type": "query", "description": "filter by trigger kind. Supports comma-separated list (e.g. 'schedule,webhook') and negation by prefixing all values with '!' (e.g. '!schedule,!webhook')" }, { "name": "script_hash", "value": "", "type": "query", "description": "mask to filter exact matching path" }, { "name": "started_before", "value": "", "type": "query", "description": "filter on started before (inclusive) timestamp" }, { "name": "started_after", "value": "", "type": "query", "description": "filter on started after (exclusive) timestamp" }, { "name": "success", "value": "", "type": "query", "description": "filter on successful jobs" }, { "name": "scheduled_for_before_now", "value": "", "type": "query", "description": "filter on jobs scheduled_for before now (hence waitinf for a worker)" }, { "name": "job_kinds", "value": "", "type": "query", "description": "filter by job kind. Supports comma-separated list of values ('preview', 'script', 'dependencies', 'flow') and negation by prefixing all values with '!' (e.g. '!preview,!dependencies')" }, { "name": "suspended", "value": "", "type": "query", "description": "filter on suspended jobs" }, { "name": "running", "value": "", "type": "query", "description": "filter on running jobs" }, { "name": "args", "value": "", "type": "query", "description": "filter on jobs containing those args as a json subset (@> in postgres)" }, { "name": "result", "value": "", "type": "query", "description": "filter on jobs containing those result as a json subset (@> in postgres)" }, { "name": "allow_wildcards", "value": "", "type": "query", "description": "allow wildcards (*) in the filter of label, tag, worker" }, { "name": "tag", "value": "", "type": "query", "description": "filter by tag/worker group. Supports comma-separated list (e.g. 'gpu,highmem') and negation by prefixing all values with '!' (e.g. '!gpu,!highmem')" }, { "name": "page", "value": "", "type": "query", "description": "which page to return (start at 1, default 1)" }, { "name": "per_page", "value": "", "type": "query", "description": "number of items to return for a given page (default 30, max 100)" }, { "name": "all_workspaces", "value": "", "type": "query", "description": "get jobs from all workspaces (only valid if request come from the `admins` workspace)" }, { "name": "is_not_schedule", "value": "", "type": "query", "description": "is not a scheduled job" } ] }, "docs": "List All Queued Jobs" }, { "info": { "name": "Get Queue Count", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/jobs/queue/count", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "all_workspaces", "value": "", "type": "query", "description": "get jobs from all workspaces (only valid if request come from the `admins` workspace)" } ] }, "docs": "Get Queue Count" }, { "info": { "name": "Get Completed Count", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/jobs/completed/count", "params": [ { "name": "workspace", "value": "", "type": "path" } ] }, "docs": "Get Completed Count" }, { "info": { "name": "Count Number of Completed Jobs with Filter", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/jobs/completed/count_jobs", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "completed_after_s_ago", "value": "", "type": "query" }, { "name": "success", "value": "", "type": "query" }, { "name": "tags", "value": "", "type": "query" }, { "name": "all_workspaces", "value": "", "type": "query" } ] }, "docs": "Count Number of Completed Jobs with Filter" }, { "info": { "name": "Get the Ids of All Jobs Matching the Given Filters", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/jobs/list_filtered_uuids", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "created_by", "value": "", "type": "query", "description": "filter by exact matching user creator. Supports comma-separated list (e.g. 'alice,bob') and negation by prefixing all values with '!' (e.g. '!alice,!bob')" }, { "name": "label", "value": "", "type": "query", "description": "filter by exact matching job label. Supports comma-separated list (e.g. 'deploy,release') and negation by prefixing all values with '!' (e.g. '!deploy,!release')" }, { "name": "worker", "value": "", "type": "query", "description": "filter by worker this job ran on. Supports comma-separated list (e.g. 'worker-1,worker-2') and negation by prefixing all values with '!' (e.g. '!worker-1,!worker-2')" }, { "name": "parent_job", "value": "", "type": "query", "description": "The parent job that is at the origin and responsible for the execution of this script if any" }, { "name": "script_path_exact", "value": "", "type": "query", "description": "filter by exact matching script path. Supports comma-separated list (e.g. 'f/script1,f/script2') and negation by prefixing all values with '!' (e.g. '!f/script1,!f/script2')" }, { "name": "script_path_start", "value": "", "type": "query", "description": "filter by script path prefix. Supports comma-separated list (e.g. 'f/folder1,f/folder2') and negation by prefixing all values with '!' (e.g. '!f/folder1,!f/folder2')" }, { "name": "schedule_path", "value": "", "type": "query", "description": "mask to filter by schedule path" }, { "name": "script_hash", "value": "", "type": "query", "description": "mask to filter exact matching path" }, { "name": "started_before", "value": "", "type": "query", "description": "filter on started before (inclusive) timestamp" }, { "name": "started_after", "value": "", "type": "query", "description": "filter on started after (exclusive) timestamp" }, { "name": "created_before", "value": "", "type": "query", "description": "filter on created before (inclusive) timestamp" }, { "name": "created_after", "value": "", "type": "query", "description": "filter on created after (exclusive) timestamp" }, { "name": "completed_before", "value": "", "type": "query", "description": "filter on started before (inclusive) timestamp" }, { "name": "completed_after", "value": "", "type": "query", "description": "filter on started after (exclusive) timestamp" }, { "name": "created_before_queue", "value": "", "type": "query", "description": "filter on jobs created before X for jobs in the queue only" }, { "name": "created_after_queue", "value": "", "type": "query", "description": "filter on jobs created after X for jobs in the queue only" }, { "name": "running", "value": "", "type": "query", "description": "filter on running jobs" }, { "name": "scheduled_for_before_now", "value": "", "type": "query", "description": "filter on jobs scheduled_for before now (hence waitinf for a worker)" }, { "name": "job_kinds", "value": "", "type": "query", "description": "filter by job kind. Supports comma-separated list of values ('preview', 'script', 'dependencies', 'flow') and negation by prefixing all values with '!' (e.g. '!preview,!dependencies')" }, { "name": "suspended", "value": "", "type": "query", "description": "filter on suspended jobs" }, { "name": "args", "value": "", "type": "query", "description": "filter on jobs containing those args as a json subset (@> in postgres)" }, { "name": "tag", "value": "", "type": "query", "description": "filter by tag/worker group. Supports comma-separated list (e.g. 'gpu,highmem') and negation by prefixing all values with '!' (e.g. '!gpu,!highmem')" }, { "name": "result", "value": "", "type": "query", "description": "filter on jobs containing those result as a json subset (@> in postgres)" }, { "name": "page", "value": "", "type": "query", "description": "which page to return (start at 1, default 1)" }, { "name": "per_page", "value": "", "type": "query", "description": "number of items to return for a given page (default 30, max 100)" }, { "name": "is_skipped", "value": "", "type": "query", "description": "is the job skipped" }, { "name": "is_flow_step", "value": "", "type": "query", "description": "is the job a flow step" }, { "name": "has_null_parent", "value": "", "type": "query", "description": "has null parent" }, { "name": "success", "value": "", "type": "query", "description": "filter on successful jobs" }, { "name": "all_workspaces", "value": "", "type": "query", "description": "get jobs from all workspaces (only valid if request come from the `admins` workspace)" }, { "name": "is_not_schedule", "value": "", "type": "query", "description": "is not a scheduled job" } ] }, "docs": "Get the Ids of All Jobs Matching the Given Filters" }, { "info": { "name": "Get the Ids of All Queued Jobs Matching the Given Filters", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/jobs/queue/list_filtered_uuids", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "order_desc", "value": "", "type": "query", "description": "order by desc order (default true)" }, { "name": "created_by", "value": "", "type": "query", "description": "filter by exact matching user creator. Supports comma-separated list (e.g. 'alice,bob') and negation by prefixing all values with '!' (e.g. '!alice,!bob')" }, { "name": "parent_job", "value": "", "type": "query", "description": "The parent job that is at the origin and responsible for the execution of this script if any" }, { "name": "script_path_exact", "value": "", "type": "query", "description": "filter by exact matching script path. Supports comma-separated list (e.g. 'f/script1,f/script2') and negation by prefixing all values with '!' (e.g. '!f/script1,!f/script2')" }, { "name": "script_path_start", "value": "", "type": "query", "description": "filter by script path prefix. Supports comma-separated list (e.g. 'f/folder1,f/folder2') and negation by prefixing all values with '!' (e.g. '!f/folder1,!f/folder2')" }, { "name": "schedule_path", "value": "", "type": "query", "description": "mask to filter by schedule path" }, { "name": "script_hash", "value": "", "type": "query", "description": "mask to filter exact matching path" }, { "name": "started_before", "value": "", "type": "query", "description": "filter on started before (inclusive) timestamp" }, { "name": "started_after", "value": "", "type": "query", "description": "filter on started after (exclusive) timestamp" }, { "name": "success", "value": "", "type": "query", "description": "filter on successful jobs" }, { "name": "scheduled_for_before_now", "value": "", "type": "query", "description": "filter on jobs scheduled_for before now (hence waitinf for a worker)" }, { "name": "job_kinds", "value": "", "type": "query", "description": "filter by job kind. Supports comma-separated list of values ('preview', 'script', 'dependencies', 'flow') and negation by prefixing all values with '!' (e.g. '!preview,!dependencies')" }, { "name": "suspended", "value": "", "type": "query", "description": "filter on suspended jobs" }, { "name": "running", "value": "", "type": "query", "description": "filter on running jobs" }, { "name": "args", "value": "", "type": "query", "description": "filter on jobs containing those args as a json subset (@> in postgres)" }, { "name": "result", "value": "", "type": "query", "description": "filter on jobs containing those result as a json subset (@> in postgres)" }, { "name": "allow_wildcards", "value": "", "type": "query", "description": "allow wildcards (*) in the filter of label, tag, worker" }, { "name": "tag", "value": "", "type": "query", "description": "filter by tag/worker group. Supports comma-separated list (e.g. 'gpu,highmem') and negation by prefixing all values with '!' (e.g. '!gpu,!highmem')" }, { "name": "page", "value": "", "type": "query", "description": "which page to return (start at 1, default 1)" }, { "name": "per_page", "value": "", "type": "query", "description": "number of items to return for a given page (default 30, max 100)" }, { "name": "concurrency_key", "value": "", "type": "query" }, { "name": "all_workspaces", "value": "", "type": "query", "description": "get jobs from all workspaces (only valid if request come from the `admins` workspace)" }, { "name": "is_not_schedule", "value": "", "type": "query", "description": "is not a scheduled job" } ] }, "docs": "Get the Ids of All Queued Jobs Matching the Given Filters" }, { "info": { "name": "Cancel Jobs Based on the Given Uuids", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/jobs/queue/cancel_selection", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "force_cancel", "value": "", "type": "query" }, { "name": "all_workspaces", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cancel Jobs Based on the Given Uuids" }, { "info": { "name": "Get OpenTelemetry Traces for a Job", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/jobs/get_otel_traces/:id", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get OpenTelemetry Traces for a Job" }, { "info": { "name": "List All Completed Jobs", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/jobs/completed/list", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "order_desc", "value": "", "type": "query", "description": "order by desc order (default true)" }, { "name": "created_by", "value": "", "type": "query", "description": "filter by exact matching user creator. Supports comma-separated list (e.g. 'alice,bob') and negation by prefixing all values with '!' (e.g. '!alice,!bob')" }, { "name": "label", "value": "", "type": "query", "description": "filter by exact matching job label. Supports comma-separated list (e.g. 'deploy,release') and negation by prefixing all values with '!' (e.g. '!deploy,!release')" }, { "name": "worker", "value": "", "type": "query", "description": "filter by worker this job ran on. Supports comma-separated list (e.g. 'worker-1,worker-2') and negation by prefixing all values with '!' (e.g. '!worker-1,!worker-2')" }, { "name": "parent_job", "value": "", "type": "query", "description": "The parent job that is at the origin and responsible for the execution of this script if any" }, { "name": "script_path_exact", "value": "", "type": "query", "description": "filter by exact matching script path. Supports comma-separated list (e.g. 'f/script1,f/script2') and negation by prefixing all values with '!' (e.g. '!f/script1,!f/script2')" }, { "name": "script_path_start", "value": "", "type": "query", "description": "filter by script path prefix. Supports comma-separated list (e.g. 'f/folder1,f/folder2') and negation by prefixing all values with '!' (e.g. '!f/folder1,!f/folder2')" }, { "name": "schedule_path", "value": "", "type": "query", "description": "mask to filter by schedule path" }, { "name": "script_hash", "value": "", "type": "query", "description": "mask to filter exact matching path" }, { "name": "started_before", "value": "", "type": "query", "description": "filter on started before (inclusive) timestamp" }, { "name": "started_after", "value": "", "type": "query", "description": "filter on started after (exclusive) timestamp" }, { "name": "success", "value": "", "type": "query", "description": "filter on successful jobs" }, { "name": "job_kinds", "value": "", "type": "query", "description": "filter by job kind. Supports comma-separated list of values ('preview', 'script', 'dependencies', 'flow') and negation by prefixing all values with '!' (e.g. '!preview,!dependencies')" }, { "name": "args", "value": "", "type": "query", "description": "filter on jobs containing those args as a json subset (@> in postgres)" }, { "name": "result", "value": "", "type": "query", "description": "filter on jobs containing those result as a json subset (@> in postgres)" }, { "name": "allow_wildcards", "value": "", "type": "query", "description": "allow wildcards (*) in the filter of label, tag, worker" }, { "name": "tag", "value": "", "type": "query", "description": "filter by tag/worker group. Supports comma-separated list (e.g. 'gpu,highmem') and negation by prefixing all values with '!' (e.g. '!gpu,!highmem')" }, { "name": "page", "value": "", "type": "query", "description": "which page to return (start at 1, default 1)" }, { "name": "per_page", "value": "", "type": "query", "description": "number of items to return for a given page (default 30, max 100)" }, { "name": "is_skipped", "value": "", "type": "query", "description": "is the job skipped" }, { "name": "is_flow_step", "value": "", "type": "query", "description": "is the job a flow step" }, { "name": "has_null_parent", "value": "", "type": "query", "description": "has null parent" }, { "name": "is_not_schedule", "value": "", "type": "query", "description": "is not a scheduled job" } ] }, "docs": "List All Completed Jobs" }, { "info": { "name": "Export All Completed Jobs for Backup/migration", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/jobs/completed/export", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query", "description": "which page to return (start at 1, default 1)" }, { "name": "per_page", "value": "", "type": "query", "description": "number of items to return for a given page (default 30, max 100)" } ] }, "docs": "Export All Completed Jobs for Backup/migration" }, { "info": { "name": "Import Completed Jobs from Backup/migration", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/jobs/completed/import", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Import Completed Jobs from Backup/migration" }, { "info": { "name": "Export All Queued Jobs for Backup/migration", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/jobs/queue/export", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query", "description": "which page to return (start at 1, default 1)" }, { "name": "per_page", "value": "", "type": "query", "description": "number of items to return for a given page (default 30, max 100)" } ] }, "docs": "Export All Queued Jobs for Backup/migration" }, { "info": { "name": "Import Queued Jobs from Backup/migration", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/jobs/queue/import", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Import Queued Jobs from Backup/migration" }, { "info": { "name": "Delete Jobs by IDs from All Related Tables", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/jobs/delete", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete Jobs by IDs from All Related Tables" }, { "info": { "name": "List All Jobs", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/jobs/list", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "created_by", "value": "", "type": "query", "description": "filter by exact matching user creator. Supports comma-separated list (e.g. 'alice,bob') and negation by prefixing all values with '!' (e.g. '!alice,!bob')" }, { "name": "label", "value": "", "type": "query", "description": "filter by exact matching job label. Supports comma-separated list (e.g. 'deploy,release') and negation by prefixing all values with '!' (e.g. '!deploy,!release')" }, { "name": "worker", "value": "", "type": "query", "description": "filter by worker this job ran on. Supports comma-separated list (e.g. 'worker-1,worker-2') and negation by prefixing all values with '!' (e.g. '!worker-1,!worker-2')" }, { "name": "parent_job", "value": "", "type": "query", "description": "The parent job that is at the origin and responsible for the execution of this script if any" }, { "name": "script_path_exact", "value": "", "type": "query", "description": "filter by exact matching script path. Supports comma-separated list (e.g. 'f/script1,f/script2') and negation by prefixing all values with '!' (e.g. '!f/script1,!f/script2')" }, { "name": "script_path_start", "value": "", "type": "query", "description": "filter by script path prefix. Supports comma-separated list (e.g. 'f/folder1,f/folder2') and negation by prefixing all values with '!' (e.g. '!f/folder1,!f/folder2')" }, { "name": "schedule_path", "value": "", "type": "query", "description": "mask to filter by schedule path" }, { "name": "script_hash", "value": "", "type": "query", "description": "mask to filter exact matching path" }, { "name": "started_before", "value": "", "type": "query", "description": "filter on started before (inclusive) timestamp" }, { "name": "started_after", "value": "", "type": "query", "description": "filter on started after (exclusive) timestamp" }, { "name": "created_before", "value": "", "type": "query", "description": "filter on created before (inclusive) timestamp" }, { "name": "created_after", "value": "", "type": "query", "description": "filter on created after (exclusive) timestamp" }, { "name": "completed_before", "value": "", "type": "query", "description": "filter on started before (inclusive) timestamp" }, { "name": "completed_after", "value": "", "type": "query", "description": "filter on started after (exclusive) timestamp" }, { "name": "created_before_queue", "value": "", "type": "query", "description": "filter on jobs created before X for jobs in the queue only" }, { "name": "created_after_queue", "value": "", "type": "query", "description": "filter on jobs created after X for jobs in the queue only" }, { "name": "running", "value": "", "type": "query", "description": "filter on running jobs" }, { "name": "scheduled_for_before_now", "value": "", "type": "query", "description": "filter on jobs scheduled_for before now (hence waitinf for a worker)" }, { "name": "job_kinds", "value": "", "type": "query", "description": "filter by job kind. Supports comma-separated list of values ('preview', 'script', 'dependencies', 'flow') and negation by prefixing all values with '!' (e.g. '!preview,!dependencies')" }, { "name": "suspended", "value": "", "type": "query", "description": "filter on suspended jobs" }, { "name": "args", "value": "", "type": "query", "description": "filter on jobs containing those args as a json subset (@> in postgres)" }, { "name": "tag", "value": "", "type": "query", "description": "filter by tag/worker group. Supports comma-separated list (e.g. 'gpu,highmem') and negation by prefixing all values with '!' (e.g. '!gpu,!highmem')" }, { "name": "result", "value": "", "type": "query", "description": "filter on jobs containing those result as a json subset (@> in postgres)" }, { "name": "allow_wildcards", "value": "", "type": "query", "description": "allow wildcards (*) in the filter of label, tag, worker" }, { "name": "per_page", "value": "", "type": "query", "description": "number of items to return for a given page (default 30, max 100)" }, { "name": "trigger_kind", "value": "", "type": "query", "description": "filter by trigger kind. Supports comma-separated list (e.g. 'schedule,webhook') and negation by prefixing all values with '!' (e.g. '!schedule,!webhook')" }, { "name": "is_skipped", "value": "", "type": "query", "description": "is the job skipped" }, { "name": "is_flow_step", "value": "", "type": "query", "description": "is the job a flow step" }, { "name": "has_null_parent", "value": "", "type": "query", "description": "has null parent" }, { "name": "success", "value": "", "type": "query", "description": "filter on successful jobs" }, { "name": "all_workspaces", "value": "", "type": "query", "description": "get jobs from all workspaces (only valid if request come from the `admins` workspace)" }, { "name": "is_not_schedule", "value": "", "type": "query", "description": "is not a scheduled job" }, { "name": "broad_filter", "value": "", "type": "query", "description": "broad search across multiple fields (case-insensitive substring match on path, tag, schedule path, trigger kind, label)" } ] }, "docs": "List All Jobs" }, { "info": { "name": "Get Db Clock", "type": "http" }, "http": { "method": "GET", "url": "/api/jobs/db_clock" }, "docs": "Get Db Clock" }, { "info": { "name": "Count Jobs by Tag", "type": "http" }, "http": { "method": "GET", "url": "/api/jobs/completed/count_by_tag", "params": [ { "name": "horizon_secs", "value": "", "type": "query", "description": "Past Time horizon in seconds (when to start the count = now - horizon) (default is 3600)" }, { "name": "workspace_id", "value": "", "type": "query", "description": "Specific workspace ID to filter results (optional)" } ] }, "docs": "Count Jobs by Tag" }, { "info": { "name": "Get Job", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/jobs_u/get/:id", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" }, { "name": "no_logs", "value": "", "type": "query" }, { "name": "no_code", "value": "", "type": "query" }, { "name": "approval_token", "value": "", "type": "query", "description": "Approval token granting read access to the job when not logged in. The token must be the one issued for this job's flow (i.e. the flow id used when generating the approval URL)." } ] }, "docs": "Get Job" }, { "info": { "name": "Get Root Job Id", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/jobs_u/get_root_job_id/:id", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get Root Job Id" }, { "info": { "name": "Get Job Logs", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/jobs_u/get_logs/:id", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" }, { "name": "remove_ansi_warnings", "value": "", "type": "query" } ] }, "docs": "Get Job Logs" }, { "info": { "name": "Get All Logs for a Flow Job", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/jobs_u/get_flow_all_logs/:id", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get All Logs for a Flow Job" }, { "info": { "name": "Get Completed Job Logs Tail", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/jobs_u/get_completed_logs_tail/:id", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get Completed Job Logs Tail" }, { "info": { "name": "Get Job Args", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/jobs_u/get_args/:id", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get Job Args" }, { "info": { "name": "Get Started at by Ids", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/jobs_u/queue/get_started_at_by_ids", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Get Started at by Ids" }, { "info": { "name": "Get Job Updates", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/jobs_u/getupdate/:id", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" }, { "name": "running", "value": "", "type": "query" }, { "name": "log_offset", "value": "", "type": "query" }, { "name": "stream_offset", "value": "", "type": "query" }, { "name": "get_progress", "value": "", "type": "query" }, { "name": "no_logs", "value": "", "type": "query" } ] }, "docs": "Get Job Updates" }, { "info": { "name": "Get Job Updates via Server-sent Events", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/jobs_u/getupdate_sse/:id", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" }, { "name": "running", "value": "", "type": "query" }, { "name": "log_offset", "value": "", "type": "query" }, { "name": "stream_offset", "value": "", "type": "query" }, { "name": "get_progress", "value": "", "type": "query" }, { "name": "only_result", "value": "", "type": "query" }, { "name": "no_logs", "value": "", "type": "query" }, { "name": "fast", "value": "", "type": "query" } ] }, "docs": "Get Job Updates via Server-sent Events" }, { "info": { "name": "Get Log File from Object Store", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/jobs_u/get_log_file/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "Get Log File from Object Store" }, { "info": { "name": "Get Flow Debug Info", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/jobs_u/get_flow_debug_info/:id", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get Flow Debug Info" }, { "info": { "name": "Get Completed Job", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/jobs_u/completed/get/:id", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get Completed Job" }, { "info": { "name": "Get Completed Job Result", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/jobs_u/completed/get_result/:id", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" }, { "name": "suspended_job", "value": "", "type": "query" }, { "name": "resume_id", "value": "", "type": "query" }, { "name": "secret", "value": "", "type": "query" }, { "name": "approver", "value": "", "type": "query" } ] }, "docs": "Get Completed Job Result" }, { "info": { "name": "Get Completed Job Result if Job is Completed", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/jobs_u/completed/get_result_maybe/:id", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" }, { "name": "get_started", "value": "", "type": "query" } ] }, "docs": "Get Completed Job Result if Job is Completed" }, { "info": { "name": "Get Completed Job Timing", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/jobs_u/completed/get_timing/:id", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get Completed Job Timing" }, { "info": { "name": "Delete Completed Job (erase Content but Keep Run Id)", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/jobs/completed/delete/:id", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete Completed Job (erase Content but Keep Run Id)" }, { "info": { "name": "Cancel Queued or Running Job", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/jobs_u/queue/cancel/:id", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cancel Queued or Running Job" }, { "info": { "name": "Cancel All Queued Jobs for Persistent Script", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/jobs_u/queue/cancel_persistent/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cancel All Queued Jobs for Persistent Script" }, { "info": { "name": "Force Cancel Queued Job", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/jobs_u/queue/force_cancel/:id", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Force Cancel Queued Job" }, { "info": { "name": "Get Queue Position for a Job", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/jobs/queue/position/:scheduled_for", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "scheduled_for", "value": "", "type": "path" } ] }, "docs": "Get Queue Position for a Job" }, { "info": { "name": "Get Scheduled for Timestamp for a Job", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/jobs/queue/scheduled_for/:id", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get Scheduled for Timestamp for a Job" }, { "info": { "name": "Create an HMac Signature Given a Job Id and a Resume Id", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/jobs/job_signature/:id/:resume_id", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" }, { "name": "resume_id", "value": "", "type": "path" }, { "name": "approver", "value": "", "type": "query" } ] }, "docs": "Create an HMac Signature Given a Job Id and a Resume Id" }, { "info": { "name": "Get Resume Urls Given a Job_id, Resume_id and a Nonce to Resume a Flow", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/jobs/resume_urls/:id/:resume_id", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" }, { "name": "resume_id", "value": "", "type": "path" }, { "name": "approver", "value": "", "type": "query" }, { "name": "flow_level", "value": "", "type": "query", "description": "If true, generate resume URLs for the parent flow instead of the specific step. This allows pre-approvals that can be consumed by any later suspend step in the same flow." } ] }, "docs": "Get Resume Urls Given a Job_id, Resume_id and a Nonce to Resume a Flow" }, { "info": { "name": "Generate Interactive Slack Approval for Suspended Job", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/jobs/slack_approval/:id", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" }, { "name": "approver", "value": "", "type": "query" }, { "name": "message", "value": "", "type": "query" }, { "name": "slack_resource_path", "value": "", "type": "query" }, { "name": "channel_id", "value": "", "type": "query" }, { "name": "flow_step_id", "value": "", "type": "query" }, { "name": "default_args_json", "value": "", "type": "query" }, { "name": "dynamic_enums_json", "value": "", "type": "query" }, { "name": "resume_button_text", "value": "", "type": "query" }, { "name": "cancel_button_text", "value": "", "type": "query" } ] }, "docs": "Generate Interactive Slack Approval for Suspended Job" }, { "info": { "name": "Generate Interactive Teams Approval for Suspended Job", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/jobs/teams_approval/:id", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" }, { "name": "approver", "value": "", "type": "query" }, { "name": "message", "value": "", "type": "query" }, { "name": "team_name", "value": "", "type": "query" }, { "name": "channel_name", "value": "", "type": "query" }, { "name": "flow_step_id", "value": "", "type": "query" }, { "name": "default_args_json", "value": "", "type": "query" }, { "name": "dynamic_enums_json", "value": "", "type": "query" }, { "name": "resume_button_text", "value": "", "type": "query" }, { "name": "cancel_button_text", "value": "", "type": "query" } ] }, "docs": "Generate Interactive Teams Approval for Suspended Job" }, { "info": { "name": "Resume or Cancel a Suspended Flow/WAC Job", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/jobs_u/flow/resume_suspended/:job_id", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "job_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Resume or cancel a suspended flow/WAC job. Uses approval rules to determine authorization. Either a valid approval_token or an authenticated session is required.\n" }, { "info": { "name": "Get Approval Info for a Suspended Flow/WAC Job", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/jobs_u/flow/approval_info/:job_id", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "job_id", "value": "", "type": "path" }, { "name": "token", "value": "", "type": "query", "description": "approval token for unauthenticated access" } ] }, "docs": "Get approval info for a suspended flow/WAC job. Returns form schema, approval rules, and whether the current user can approve. Either a valid token query parameter or an authenticated session is required.\n" }, { "info": { "name": "Resume a Job for a Suspended Flow", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/jobs_u/resume/:id/:resume_id/:signature", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" }, { "name": "payload", "value": "", "type": "query", "description": "The base64 encoded payload that has been encoded as a JSON. e.g how to encode such payload encodeURIComponent\n`encodeURIComponent(btoa(JSON.stringify({a: 2})))`\n" }, { "name": "resume_id", "value": "", "type": "path" }, { "name": "signature", "value": "", "type": "path" }, { "name": "approver", "value": "", "type": "query" } ] }, "docs": "Resume a Job for a Suspended Flow" }, { "info": { "name": "Resume a Job for a Suspended Flow", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/jobs_u/resume/:id/:resume_id/:signature", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" }, { "name": "resume_id", "value": "", "type": "path" }, { "name": "signature", "value": "", "type": "path" }, { "name": "approver", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Resume a Job for a Suspended Flow" }, { "info": { "name": "Get Flow User State at a Given Key", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/jobs/flow/user_states/:id/:key", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" }, { "name": "key", "value": "", "type": "path" } ] }, "docs": "Get Flow User State at a Given Key" }, { "info": { "name": "Set Flow User State at a Given Key", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/jobs/flow/user_states/:id/:key", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" }, { "name": "key", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Set Flow User State at a Given Key" }, { "info": { "name": "Resume a Job for a Suspended Flow as an Owner", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/jobs/flow/resume/:id", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Resume a Job for a Suspended Flow as an Owner" }, { "info": { "name": "Cancel a Job for a Suspended Flow", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/jobs_u/cancel/:id/:resume_id/:signature", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" }, { "name": "resume_id", "value": "", "type": "path" }, { "name": "signature", "value": "", "type": "path" }, { "name": "approver", "value": "", "type": "query" } ] }, "docs": "Cancel a Job for a Suspended Flow" }, { "info": { "name": "Cancel a Job for a Suspended Flow", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/jobs_u/cancel/:id/:resume_id/:signature", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" }, { "name": "resume_id", "value": "", "type": "path" }, { "name": "signature", "value": "", "type": "path" }, { "name": "approver", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cancel a Job for a Suspended Flow" }, { "info": { "name": "Get Parent Flow Job of Suspended Job", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/jobs_u/get_flow/:id/:resume_id/:signature", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" }, { "name": "resume_id", "value": "", "type": "path" }, { "name": "signature", "value": "", "type": "path" }, { "name": "approver", "value": "", "type": "query" } ] }, "docs": "Get Parent Flow Job of Suspended Job" } ] }, { "info": { "name": "flow_conversations", "type": "folder" }, "items": [ { "info": { "name": "List Flow Conversations", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/flow_conversations/list", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query", "description": "which page to return (start at 1, default 1)" }, { "name": "per_page", "value": "", "type": "query", "description": "number of items to return for a given page (default 30, max 100)" }, { "name": "flow_path", "value": "", "type": "query", "description": "filter conversations by flow path" } ] }, "docs": "List Flow Conversations" }, { "info": { "name": "Delete Flow Conversation", "type": "http" }, "http": { "method": "DELETE", "url": "/api/w/:workspace/flow_conversations/delete/:conversation_id", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "conversation_id", "value": "", "type": "path", "description": "conversation id" } ] }, "docs": "Delete Flow Conversation" }, { "info": { "name": "List Conversation Messages", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/flow_conversations/:conversation_id/messages", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query", "description": "which page to return (start at 1, default 1)" }, { "name": "per_page", "value": "", "type": "query", "description": "number of items to return for a given page (default 30, max 100)" }, { "name": "conversation_id", "value": "", "type": "path", "description": "conversation id" }, { "name": "after_seq", "value": "", "type": "query", "description": "Message sequence cursor to fetch only the messages after that cursor" } ] }, "docs": "List Conversation Messages" } ] }, { "info": { "name": "path_autocomplete", "type": "folder" }, "items": [ { "info": { "name": "List All Paths in a Workspace for Client-side Autocomplete", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/path_autocomplete/list_paths", "params": [ { "name": "workspace", "value": "", "type": "path" } ] }, "docs": "Returns the flat list of all item paths visible to the caller across\nscripts, flows, apps, raw apps, variables, and resources. Intended to\nfeed an entirely client-side path autocomplete UI: the frontend fetches\nonce (server caches per workspace for 60s) and performs all prefix/segment\ncomputation locally. Capped at 20,000 paths (5,000 per table).\n" } ] }, { "info": { "name": "raw_app", "type": "folder" }, "items": [ { "info": { "name": "List All Raw Apps", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/raw_apps/list", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query", "description": "which page to return (start at 1, default 1)" }, { "name": "per_page", "value": "", "type": "query", "description": "number of items to return for a given page (default 30, max 100)" }, { "name": "order_desc", "value": "", "type": "query", "description": "order by desc order (default true)" }, { "name": "created_by", "value": "", "type": "query", "description": "filter by exact matching user creator. Supports comma-separated list (e.g. 'alice,bob') and negation by prefixing all values with '!' (e.g. '!alice,!bob')" }, { "name": "path_start", "value": "", "type": "query", "description": "mask to filter matching starting path" }, { "name": "path_exact", "value": "", "type": "query", "description": "mask to filter exact matching path" }, { "name": "starred_only", "value": "", "type": "query", "description": "(default false)\nshow only the starred items\n" }, { "name": "label", "value": "", "type": "query", "description": "Filter by label" } ] }, "docs": "List All Raw Apps" } ] }, { "info": { "name": "trigger", "type": "folder" }, "items": [ { "info": { "name": "Resume All Suspended Jobs for a Specific Trigger", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/trigger/:trigger_kind/resume_suspended_trigger_jobs/:trigger_path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "trigger_kind", "value": "", "type": "path", "description": "The kind of trigger" }, { "name": "trigger_path", "value": "", "type": "path", "description": "The path of the trigger (can contain forward slashes)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Resume All Suspended Jobs for a Specific Trigger" }, { "info": { "name": "Cancel All Suspended Jobs for a Specific Trigger", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/trigger/:trigger_kind/cancel_suspended_trigger_jobs/:trigger_path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "trigger_kind", "value": "", "type": "path", "description": "The kind of trigger" }, { "name": "trigger_path", "value": "", "type": "path", "description": "The path of the trigger (can contain forward slashes)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cancel All Suspended Jobs for a Specific Trigger" } ] }, { "info": { "name": "schedule", "type": "folder" }, "items": [ { "info": { "name": "Preview Schedule", "type": "http" }, "http": { "method": "POST", "url": "/api/schedules/preview", "body": { "type": "json", "data": "{}" } }, "docs": "Preview Schedule" }, { "info": { "name": "Create Schedule", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/schedules/create", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create Schedule" }, { "info": { "name": "Update Schedule", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/schedules/update/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update Schedule" }, { "info": { "name": "Set Enabled Schedule", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/schedules/setenabled/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Set Enabled Schedule" }, { "info": { "name": "Delete Schedule", "type": "http" }, "http": { "method": "DELETE", "url": "/api/w/:workspace/schedules/delete/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "Delete Schedule" }, { "info": { "name": "Get Schedule", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/schedules/get/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "Get Schedule" }, { "info": { "name": "Does Schedule Exists", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/schedules/exists/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "Does Schedule Exists" }, { "info": { "name": "List Schedules", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/schedules/list", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query", "description": "which page to return (start at 1, default 1)" }, { "name": "per_page", "value": "", "type": "query", "description": "number of items to return for a given page (default 30, max 100)" }, { "name": "args", "value": "", "type": "query", "description": "filter on jobs containing those args as a json subset (@> in postgres)" }, { "name": "path", "value": "", "type": "query", "description": "filter by path (script path)" }, { "name": "is_flow", "value": "", "type": "query", "description": "filter schedules by whether they target a flow" }, { "name": "path_start", "value": "", "type": "query", "description": "filter schedules by path prefix" }, { "name": "schedule_path", "value": "", "type": "query", "description": "exact match on the schedule's path" }, { "name": "description", "value": "", "type": "query", "description": "pattern match filter for description field (case-insensitive)" }, { "name": "summary", "value": "", "type": "query", "description": "pattern match filter for summary field (case-insensitive)" }, { "name": "broad_filter", "value": "", "type": "query", "description": "broad search across multiple fields (case-insensitive substring match)" }, { "name": "label", "value": "", "type": "query", "description": "Filter by label" } ] }, "docs": "List Schedules" }, { "info": { "name": "List Schedules with Last 20 Jobs", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/schedules/list_with_jobs", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query", "description": "which page to return (start at 1, default 1)" }, { "name": "per_page", "value": "", "type": "query", "description": "number of items to return for a given page (default 30, max 100)" } ] }, "docs": "List Schedules with Last 20 Jobs" }, { "info": { "name": "Set Default Error or Recoevery Handler", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/schedules/setdefaulthandler", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Set Default Error or Recoevery Handler" } ] }, { "info": { "name": "openapi", "type": "folder" }, "items": [ { "info": { "name": "Generate Openapi Spec from Http Routes/webhook", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/openapi/generate", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Generate Openapi Spec from Http Routes/webhook" }, { "info": { "name": "Download the OpenAPI V3.1 Spec as a File", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/openapi/download", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Download the OpenAPI V3.1 Spec as a File" } ] }, { "info": { "name": "http_trigger", "type": "folder" }, "items": [ { "info": { "name": "Create Many HTTP Triggers", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/http_triggers/create_many", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create Many HTTP Triggers" }, { "info": { "name": "Create Http Trigger", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/http_triggers/create", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create Http Trigger" }, { "info": { "name": "Update Http Trigger", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/http_triggers/update/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update Http Trigger" }, { "info": { "name": "Delete Http Trigger", "type": "http" }, "http": { "method": "DELETE", "url": "/api/w/:workspace/http_triggers/delete/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "Delete Http Trigger" }, { "info": { "name": "Get Http Trigger", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/http_triggers/get/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "Get Http Trigger" }, { "info": { "name": "List Http Triggers", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/http_triggers/list", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query", "description": "which page to return (start at 1, default 1)" }, { "name": "per_page", "value": "", "type": "query", "description": "number of items to return for a given page (default 30, max 100)" }, { "name": "path", "value": "", "type": "query", "description": "filter by path" }, { "name": "is_flow", "value": "", "type": "query" }, { "name": "path_start", "value": "", "type": "query" }, { "name": "label", "value": "", "type": "query", "description": "Filter by label" } ] }, "docs": "List Http Triggers" }, { "info": { "name": "Does Http Trigger Exists", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/http_triggers/exists/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "Does Http Trigger Exists" }, { "info": { "name": "Does Route Exists", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/http_triggers/route_exists", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Does Route Exists" }, { "info": { "name": "Enable/disable Http Trigger", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/http_triggers/setmode/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Enable/disable Http Trigger" } ] }, { "info": { "name": "websocket_trigger", "type": "folder" }, "items": [ { "info": { "name": "Create Websocket Trigger", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/websocket_triggers/create", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create Websocket Trigger" }, { "info": { "name": "Update Websocket Trigger", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/websocket_triggers/update/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update Websocket Trigger" }, { "info": { "name": "Delete Websocket Trigger", "type": "http" }, "http": { "method": "DELETE", "url": "/api/w/:workspace/websocket_triggers/delete/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "Delete Websocket Trigger" }, { "info": { "name": "Get Websocket Trigger", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/websocket_triggers/get/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "Get Websocket Trigger" }, { "info": { "name": "List Websocket Triggers", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/websocket_triggers/list", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query", "description": "which page to return (start at 1, default 1)" }, { "name": "per_page", "value": "", "type": "query", "description": "number of items to return for a given page (default 30, max 100)" }, { "name": "path", "value": "", "type": "query", "description": "filter by path" }, { "name": "is_flow", "value": "", "type": "query" }, { "name": "path_start", "value": "", "type": "query" }, { "name": "label", "value": "", "type": "query", "description": "Filter by label" } ] }, "docs": "List Websocket Triggers" }, { "info": { "name": "Does Websocket Trigger Exists", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/websocket_triggers/exists/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "Does Websocket Trigger Exists" }, { "info": { "name": "Set Enabled Websocket Trigger", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/websocket_triggers/setmode/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Set Enabled Websocket Trigger" }, { "info": { "name": "Test Websocket Connection", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/websocket_triggers/test", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Test Websocket Connection" } ] }, { "info": { "name": "kafka_trigger", "type": "folder" }, "items": [ { "info": { "name": "Create Kafka Trigger", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/kafka_triggers/create", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create Kafka Trigger" }, { "info": { "name": "Update Kafka Trigger", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/kafka_triggers/update/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update Kafka Trigger" }, { "info": { "name": "Delete Kafka Trigger", "type": "http" }, "http": { "method": "DELETE", "url": "/api/w/:workspace/kafka_triggers/delete/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "Delete Kafka Trigger" }, { "info": { "name": "Get Kafka Trigger", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/kafka_triggers/get/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "Get Kafka Trigger" }, { "info": { "name": "List Kafka Triggers", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/kafka_triggers/list", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query", "description": "which page to return (start at 1, default 1)" }, { "name": "per_page", "value": "", "type": "query", "description": "number of items to return for a given page (default 30, max 100)" }, { "name": "path", "value": "", "type": "query", "description": "filter by path" }, { "name": "is_flow", "value": "", "type": "query" }, { "name": "path_start", "value": "", "type": "query" }, { "name": "label", "value": "", "type": "query", "description": "Filter by label" } ] }, "docs": "List Kafka Triggers" }, { "info": { "name": "Does Kafka Trigger Exists", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/kafka_triggers/exists/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "Does Kafka Trigger Exists" }, { "info": { "name": "Set Enabled Kafka Trigger", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/kafka_triggers/setmode/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Set Enabled Kafka Trigger" }, { "info": { "name": "Test Kafka Connection", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/kafka_triggers/test", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Test Kafka Connection" }, { "info": { "name": "Reset Kafka Trigger Offsets to Earliest", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/kafka_triggers/reset_offsets/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "Reset Kafka Trigger Offsets to Earliest" }, { "info": { "name": "Commit Kafka Offsets for a Specific Trigger", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/kafka_triggers/commit_offsets/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Commit Kafka Offsets for a Specific Trigger" } ] }, { "info": { "name": "nats_trigger", "type": "folder" }, "items": [ { "info": { "name": "Create Nats Trigger", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/nats_triggers/create", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create Nats Trigger" }, { "info": { "name": "Update Nats Trigger", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/nats_triggers/update/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update Nats Trigger" }, { "info": { "name": "Delete Nats Trigger", "type": "http" }, "http": { "method": "DELETE", "url": "/api/w/:workspace/nats_triggers/delete/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "Delete Nats Trigger" }, { "info": { "name": "Get Nats Trigger", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/nats_triggers/get/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "Get Nats Trigger" }, { "info": { "name": "List Nats Triggers", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/nats_triggers/list", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query", "description": "which page to return (start at 1, default 1)" }, { "name": "per_page", "value": "", "type": "query", "description": "number of items to return for a given page (default 30, max 100)" }, { "name": "path", "value": "", "type": "query", "description": "filter by path" }, { "name": "is_flow", "value": "", "type": "query" }, { "name": "path_start", "value": "", "type": "query" }, { "name": "label", "value": "", "type": "query", "description": "Filter by label" } ] }, "docs": "List Nats Triggers" }, { "info": { "name": "Does Nats Trigger Exists", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/nats_triggers/exists/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "Does Nats Trigger Exists" }, { "info": { "name": "Set Enabled Nats Trigger", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/nats_triggers/setmode/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Set Enabled Nats Trigger" }, { "info": { "name": "Test NATS Connection", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/nats_triggers/test", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Test NATS Connection" } ] }, { "info": { "name": "sqs_trigger", "type": "folder" }, "items": [ { "info": { "name": "Create Sqs Trigger", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/sqs_triggers/create", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create Sqs Trigger" }, { "info": { "name": "Update Sqs Trigger", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/sqs_triggers/update/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update Sqs Trigger" }, { "info": { "name": "Delete Sqs Trigger", "type": "http" }, "http": { "method": "DELETE", "url": "/api/w/:workspace/sqs_triggers/delete/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "Delete Sqs Trigger" }, { "info": { "name": "Get Sqs Trigger", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/sqs_triggers/get/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "Get Sqs Trigger" }, { "info": { "name": "List Sqs Triggers", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/sqs_triggers/list", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query", "description": "which page to return (start at 1, default 1)" }, { "name": "per_page", "value": "", "type": "query", "description": "number of items to return for a given page (default 30, max 100)" }, { "name": "path", "value": "", "type": "query", "description": "filter by path" }, { "name": "is_flow", "value": "", "type": "query" }, { "name": "path_start", "value": "", "type": "query" }, { "name": "label", "value": "", "type": "query", "description": "Filter by label" } ] }, "docs": "List Sqs Triggers" }, { "info": { "name": "Does Sqs Trigger Exists", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/sqs_triggers/exists/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "Does Sqs Trigger Exists" }, { "info": { "name": "Set Enabled Sqs Trigger", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/sqs_triggers/setmode/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Set Enabled Sqs Trigger" }, { "info": { "name": "Test Sqs Connection", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/sqs_triggers/test", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Test Sqs Connection" } ] }, { "info": { "name": "workspace_integration", "type": "folder" }, "items": [ { "info": { "name": "List Available Native Trigger Services", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/native_triggers/integrations/list", "params": [ { "name": "workspace", "value": "", "type": "path" } ] }, "docs": "List Available Native Trigger Services" }, { "info": { "name": "Check if Integrations for a Particular Service Exists", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/native_triggers/integrations/:service_name/exists", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "service_name", "value": "", "type": "path" } ] }, "docs": "Check if Integrations for a Particular Service Exists" }, { "info": { "name": "Create Native Trigger Service", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/native_triggers/integrations/:service_name/create", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "service_name", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create Native Trigger Service" }, { "info": { "name": "Generate Connect Url for Native Trigger Service", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/native_triggers/integrations/:service_name/generate_connect_url", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "service_name", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Generate Connect Url for Native Trigger Service" }, { "info": { "name": "Check if Instance-level Credential Sharing is Available for a Service", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/native_triggers/integrations/:service_name/instance_sharing_available", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "service_name", "value": "", "type": "path" } ] }, "docs": "Check if Instance-level Credential Sharing is Available for a Service" }, { "info": { "name": "Generate Connect Url Using Instance-level Credentials", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/native_triggers/integrations/:service_name/generate_instance_connect_url", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "service_name", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Generate Connect Url Using Instance-level Credentials" }, { "info": { "name": "Delete Native Trigger Service", "type": "http" }, "http": { "method": "DELETE", "url": "/api/w/:workspace/native_triggers/integrations/:service_name/delete", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "service_name", "value": "", "type": "path" } ] }, "docs": "Delete Native Trigger Service" }, { "info": { "name": "Native Trigger Service Oauth Callback", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/native_triggers/integrations/:service_name/callback", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "service_name", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Native Trigger Service Oauth Callback" } ] }, { "info": { "name": "native_trigger", "type": "folder" }, "items": [ { "info": { "name": "Create Native Trigger", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/native_triggers/:service_name/create", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "service_name", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new native trigger for the specified service.\nRequires write access to the script or flow that the trigger will be associated with.\n" }, { "info": { "name": "Update Native Trigger", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/native_triggers/:service_name/update/:external_id", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "service_name", "value": "", "type": "path" }, { "name": "external_id", "value": "", "type": "path", "description": "The external ID of the trigger from the external service" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing native trigger.\nRequires write access to the script or flow that the trigger is associated with.\n" }, { "info": { "name": "Get Native Trigger", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/native_triggers/:service_name/get/:external_id", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "service_name", "value": "", "type": "path" }, { "name": "external_id", "value": "", "type": "path", "description": "The external ID of the trigger from the external service" } ] }, "docs": "Retrieves a native trigger by its external ID.\nRequires write access to the script or flow that the trigger is associated with.\n" }, { "info": { "name": "Delete Native Trigger", "type": "http" }, "http": { "method": "DELETE", "url": "/api/w/:workspace/native_triggers/:service_name/delete/:external_id", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "service_name", "value": "", "type": "path" }, { "name": "external_id", "value": "", "type": "path", "description": "The external ID of the trigger from the external service" } ] }, "docs": "Deletes a native trigger by its external ID.\nRequires write access to the script or flow that the trigger is associated with.\n" }, { "info": { "name": "List Native Triggers", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/native_triggers/:service_name/list", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "service_name", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query", "description": "which page to return (start at 1, default 1)" }, { "name": "per_page", "value": "", "type": "query", "description": "number of items to return for a given page (default 30, max 100)" }, { "name": "path", "value": "", "type": "query", "description": "filter by script path" }, { "name": "is_flow", "value": "", "type": "query", "description": "filter by is_flow" }, { "name": "label", "value": "", "type": "query", "description": "Filter by label" } ] }, "docs": "Lists all native triggers for the specified service in the workspace." }, { "info": { "name": "Check if Native Trigger Exists", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/native_triggers/:service_name/exists/:external_id", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "service_name", "value": "", "type": "path" }, { "name": "external_id", "value": "", "type": "path", "description": "The external ID of the trigger from the external service" } ] }, "docs": "Checks if a native trigger with the given external ID exists." }, { "info": { "name": "Sync Native Triggers with External Service", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/native_triggers/:service_name/sync", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "service_name", "value": "", "type": "path" } ] }, "docs": "Sync Native Triggers with External Service" }, { "info": { "name": "List Available NextCloud Events", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/native_triggers/nextcloud/events", "params": [ { "name": "workspace", "value": "", "type": "path" } ] }, "docs": "List Available NextCloud Events" }, { "info": { "name": "List Google Calendars for the Authenticated User", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/native_triggers/google/calendars", "params": [ { "name": "workspace", "value": "", "type": "path" } ] }, "docs": "List Google Calendars for the Authenticated User" }, { "info": { "name": "List or Search Google Drive Files", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/native_triggers/google/drive/files", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "q", "value": "", "type": "query", "description": "search query to filter files by name" }, { "name": "parent_id", "value": "", "type": "query", "description": "folder ID to list children of" }, { "name": "page_token", "value": "", "type": "query", "description": "token for next page of results" }, { "name": "shared_with_me", "value": "", "type": "query", "description": "if true, list files shared with the user" } ] }, "docs": "List or Search Google Drive Files" }, { "info": { "name": "List Shared Drives Accessible to the User", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/native_triggers/google/drive/shared_drives", "params": [ { "name": "workspace", "value": "", "type": "path" } ] }, "docs": "List Shared Drives Accessible to the User" }, { "info": { "name": "List GitHub Repositories Accessible to the User", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/native_triggers/github/repos", "params": [ { "name": "workspace", "value": "", "type": "path" } ] }, "docs": "List GitHub Repositories Accessible to the User" }, { "info": { "name": "Receive Webhook from External Native Trigger Service", "type": "http" }, "http": { "method": "POST", "url": "/api/native_triggers/:service_name/w/:workspace_id/webhook/:internal_id", "params": [ { "name": "service_name", "value": "", "type": "path" }, { "name": "workspace_id", "value": "", "type": "path" }, { "name": "internal_id", "value": "", "type": "path", "description": "The internal database ID of the trigger" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Receive Webhook from External Native Trigger Service" } ] }, { "info": { "name": "mqtt_trigger", "type": "folder" }, "items": [ { "info": { "name": "Create Mqtt Trigger", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/mqtt_triggers/create", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create Mqtt Trigger" }, { "info": { "name": "Update Mqtt Trigger", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/mqtt_triggers/update/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update Mqtt Trigger" }, { "info": { "name": "Delete Mqtt Trigger", "type": "http" }, "http": { "method": "DELETE", "url": "/api/w/:workspace/mqtt_triggers/delete/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "Delete Mqtt Trigger" }, { "info": { "name": "Get Mqtt Trigger", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/mqtt_triggers/get/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "Get Mqtt Trigger" }, { "info": { "name": "List Mqtt Triggers", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/mqtt_triggers/list", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query", "description": "which page to return (start at 1, default 1)" }, { "name": "per_page", "value": "", "type": "query", "description": "number of items to return for a given page (default 30, max 100)" }, { "name": "path", "value": "", "type": "query", "description": "filter by path" }, { "name": "is_flow", "value": "", "type": "query" }, { "name": "path_start", "value": "", "type": "query" }, { "name": "label", "value": "", "type": "query", "description": "Filter by label" } ] }, "docs": "List Mqtt Triggers" }, { "info": { "name": "Does Mqtt Trigger Exists", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/mqtt_triggers/exists/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "Does Mqtt Trigger Exists" }, { "info": { "name": "Set Enabled Mqtt Trigger", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/mqtt_triggers/setmode/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Set Enabled Mqtt Trigger" }, { "info": { "name": "Test Mqtt Connection", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/mqtt_triggers/test", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Test Mqtt Connection" } ] }, { "info": { "name": "gcp_trigger", "type": "folder" }, "items": [ { "info": { "name": "Create Gcp Trigger", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/gcp_triggers/create", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create Gcp Trigger" }, { "info": { "name": "Update Gcp Trigger", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/gcp_triggers/update/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update Gcp Trigger" }, { "info": { "name": "Delete Gcp Trigger", "type": "http" }, "http": { "method": "DELETE", "url": "/api/w/:workspace/gcp_triggers/delete/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "Delete Gcp Trigger" }, { "info": { "name": "Get Gcp Trigger", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/gcp_triggers/get/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "Get Gcp Trigger" }, { "info": { "name": "List Gcp Triggers", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/gcp_triggers/list", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query", "description": "which page to return (start at 1, default 1)" }, { "name": "per_page", "value": "", "type": "query", "description": "number of items to return for a given page (default 30, max 100)" }, { "name": "path", "value": "", "type": "query", "description": "filter by path" }, { "name": "is_flow", "value": "", "type": "query" }, { "name": "path_start", "value": "", "type": "query" }, { "name": "label", "value": "", "type": "query", "description": "Filter by label" } ] }, "docs": "List Gcp Triggers" }, { "info": { "name": "Does Gcp Trigger Exists", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/gcp_triggers/exists/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "Does Gcp Trigger Exists" }, { "info": { "name": "Set Enabled Gcp Trigger", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/gcp_triggers/setmode/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Set Enabled Gcp Trigger" }, { "info": { "name": "Test Gcp Connection", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/gcp_triggers/test", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Test Gcp Connection" }, { "info": { "name": "Delete Gcp Trigger", "type": "http" }, "http": { "method": "DELETE", "url": "/api/w/:workspace/gcp_triggers/subscriptions/delete/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete Gcp Trigger" }, { "info": { "name": "List All Topics of Google Cloud Service", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/gcp_triggers/topics/list/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "List All Topics of Google Cloud Service" }, { "info": { "name": "List All Subscription of a Give Topic from Google Cloud Service", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/gcp_triggers/subscriptions/list/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "List All Subscription of a Give Topic from Google Cloud Service" } ] }, { "info": { "name": "azure_trigger", "type": "folder" }, "items": [ { "info": { "name": "Create an Azure Event Grid Trigger", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/azure_triggers/create", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create an Azure Event Grid Trigger" }, { "info": { "name": "Update an Azure Event Grid Trigger", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/azure_triggers/update/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an Azure Event Grid Trigger" }, { "info": { "name": "Delete an Azure Event Grid Trigger", "type": "http" }, "http": { "method": "DELETE", "url": "/api/w/:workspace/azure_triggers/delete/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "Delete an Azure Event Grid Trigger" }, { "info": { "name": "Get an Azure Event Grid Trigger", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/azure_triggers/get/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "Get an Azure Event Grid Trigger" }, { "info": { "name": "List Azure Triggers", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/azure_triggers/list", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query", "description": "which page to return (start at 1, default 1)" }, { "name": "per_page", "value": "", "type": "query", "description": "number of items to return for a given page (default 30, max 100)" }, { "name": "path", "value": "", "type": "query", "description": "filter by exact path" }, { "name": "is_flow", "value": "", "type": "query" }, { "name": "path_start", "value": "", "type": "query" } ] }, "docs": "List Azure Triggers" }, { "info": { "name": "Check Whether an Azure Trigger Exists", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/azure_triggers/exists/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "Check Whether an Azure Trigger Exists" }, { "info": { "name": "Set Azure Trigger Mode", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/azure_triggers/setmode/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Set Azure Trigger Mode" }, { "info": { "name": "Test Azure Service Principal Connection", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/azure_triggers/test", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Test Azure Service Principal Connection" }, { "info": { "name": "List Topics Under an Event Grid Namespace", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/azure_triggers/namespaces/topics/list/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "List Topics Under an Event Grid Namespace" }, { "info": { "name": "List Subscriptions Under a Namespace Topic", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/azure_triggers/namespaces/subscriptions/list/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "List Subscriptions Under a Namespace Topic" }, { "info": { "name": "Delete an Event Grid Subscription on Azure", "type": "http" }, "http": { "method": "DELETE", "url": "/api/w/:workspace/azure_triggers/subscriptions/delete/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete an Event Grid Subscription on Azure" }, { "info": { "name": "List Event Grid Namespaces the Service Principal Can Access", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/azure_triggers/namespaces/list/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "List Event Grid Namespaces the Service Principal Can Access" }, { "info": { "name": "List Basic Event Grid Topics + System Topics the Service Principal Can Access", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/azure_triggers/basic/topics/list/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "List Basic Event Grid Topics + System Topics the Service Principal Can Access" } ] }, { "info": { "name": "postgres_trigger", "type": "folder" }, "items": [ { "info": { "name": "Get Postgres Version", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/postgres_triggers/postgres/version/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "Get Postgres Version" }, { "info": { "name": "Check if Postgres Configuration is Set to Logical", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/postgres_triggers/is_valid_postgres_configuration/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "Check if Postgres Configuration is Set to Logical" }, { "info": { "name": "Create Template Script", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/postgres_triggers/create_template_script", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create Template Script" }, { "info": { "name": "Get Template Script", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/postgres_triggers/get_template_script/:id", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get Template Script" }, { "info": { "name": "List Postgres Replication Slot", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/postgres_triggers/slot/list/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "List Postgres Replication Slot" }, { "info": { "name": "Create Replication Slot for Postgres", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/postgres_triggers/slot/create/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create Replication Slot for Postgres" }, { "info": { "name": "Delete Postgres Replication Slot", "type": "http" }, "http": { "method": "DELETE", "url": "/api/w/:workspace/postgres_triggers/slot/delete/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete Postgres Replication Slot" }, { "info": { "name": "List Postgres Publication", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/postgres_triggers/publication/list/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "List Postgres Publication" }, { "info": { "name": "Get Postgres Publication", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/postgres_triggers/publication/get/:publication/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" }, { "name": "publication", "value": "", "type": "path", "description": "The name of the publication" } ] }, "docs": "Get Postgres Publication" }, { "info": { "name": "Create Publication for Postgres", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/postgres_triggers/publication/create/:publication/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" }, { "name": "publication", "value": "", "type": "path", "description": "The name of the publication" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create Publication for Postgres" }, { "info": { "name": "Update Publication for Postgres", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/postgres_triggers/publication/update/:publication/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" }, { "name": "publication", "value": "", "type": "path", "description": "The name of the publication" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update Publication for Postgres" }, { "info": { "name": "Delete Postgres Publication", "type": "http" }, "http": { "method": "DELETE", "url": "/api/w/:workspace/postgres_triggers/publication/delete/:publication/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" }, { "name": "publication", "value": "", "type": "path", "description": "The name of the publication" } ] }, "docs": "Delete Postgres Publication" }, { "info": { "name": "Create Postgres Trigger", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/postgres_triggers/create", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create Postgres Trigger" }, { "info": { "name": "Update Postgres Trigger", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/postgres_triggers/update/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update Postgres Trigger" }, { "info": { "name": "Delete Postgres Trigger", "type": "http" }, "http": { "method": "DELETE", "url": "/api/w/:workspace/postgres_triggers/delete/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "Delete Postgres Trigger" }, { "info": { "name": "Get Postgres Trigger", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/postgres_triggers/get/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "Get Postgres Trigger" }, { "info": { "name": "List Postgres Triggers", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/postgres_triggers/list", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query", "description": "which page to return (start at 1, default 1)" }, { "name": "per_page", "value": "", "type": "query", "description": "number of items to return for a given page (default 30, max 100)" }, { "name": "path", "value": "", "type": "query", "description": "filter by path" }, { "name": "is_flow", "value": "", "type": "query" }, { "name": "path_start", "value": "", "type": "query" }, { "name": "label", "value": "", "type": "query", "description": "Filter by label" } ] }, "docs": "List Postgres Triggers" }, { "info": { "name": "Does Postgres Trigger Exists", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/postgres_triggers/exists/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "Does Postgres Trigger Exists" }, { "info": { "name": "Set Enabled Postgres Trigger", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/postgres_triggers/setmode/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Set Enabled Postgres Trigger" }, { "info": { "name": "Test Postgres Connection", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/postgres_triggers/test", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Test Postgres Connection" } ] }, { "info": { "name": "email_trigger", "type": "folder" }, "items": [ { "info": { "name": "Create Email Trigger", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/email_triggers/create", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create Email Trigger" }, { "info": { "name": "Update Email Trigger", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/email_triggers/update/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update Email Trigger" }, { "info": { "name": "Delete Email Trigger", "type": "http" }, "http": { "method": "DELETE", "url": "/api/w/:workspace/email_triggers/delete/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "Delete Email Trigger" }, { "info": { "name": "Get Email Trigger", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/email_triggers/get/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "Get Email Trigger" }, { "info": { "name": "List Email Triggers", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/email_triggers/list", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query", "description": "which page to return (start at 1, default 1)" }, { "name": "per_page", "value": "", "type": "query", "description": "number of items to return for a given page (default 30, max 100)" }, { "name": "path", "value": "", "type": "query", "description": "filter by path" }, { "name": "is_flow", "value": "", "type": "query" }, { "name": "path_start", "value": "", "type": "query" }, { "name": "label", "value": "", "type": "query", "description": "Filter by label" } ] }, "docs": "List Email Triggers" }, { "info": { "name": "Does Email Trigger Exists", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/email_triggers/exists/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "Does Email Trigger Exists" }, { "info": { "name": "Does Email Local Part Exists", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/email_triggers/local_part_exists", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Does Email Local Part Exists" }, { "info": { "name": "Enable/disable Email Trigger", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/email_triggers/setmode/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Enable/disable Email Trigger" } ] }, { "info": { "name": "group", "type": "folder" }, "items": [ { "info": { "name": "List Instance Groups", "type": "http" }, "http": { "method": "GET", "url": "/api/groups/list" }, "docs": "List Instance Groups" }, { "info": { "name": "List Instance Groups with Workspace Information", "type": "http" }, "http": { "method": "GET", "url": "/api/groups/list_with_workspaces" }, "docs": "List Instance Groups with Workspace Information" }, { "info": { "name": "Get Instance Group", "type": "http" }, "http": { "method": "GET", "url": "/api/groups/get/:name", "params": [ { "name": "name", "value": "", "type": "path" } ] }, "docs": "Get Instance Group" }, { "info": { "name": "Create Instance Group", "type": "http" }, "http": { "method": "POST", "url": "/api/groups/create", "body": { "type": "json", "data": "{}" } }, "docs": "Create Instance Group" }, { "info": { "name": "Update Instance Group", "type": "http" }, "http": { "method": "POST", "url": "/api/groups/update/:name", "params": [ { "name": "name", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update Instance Group" }, { "info": { "name": "Delete Instance Group", "type": "http" }, "http": { "method": "DELETE", "url": "/api/groups/delete/:name", "params": [ { "name": "name", "value": "", "type": "path" } ] }, "docs": "Delete Instance Group" }, { "info": { "name": "Add User to Instance Group", "type": "http" }, "http": { "method": "POST", "url": "/api/groups/adduser/:name", "params": [ { "name": "name", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add User to Instance Group" }, { "info": { "name": "Remove User from Instance Group", "type": "http" }, "http": { "method": "POST", "url": "/api/groups/removeuser/:name", "params": [ { "name": "name", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Remove User from Instance Group" }, { "info": { "name": "Export Instance Groups", "type": "http" }, "http": { "method": "GET", "url": "/api/groups/export" }, "docs": "Export Instance Groups" }, { "info": { "name": "Overwrite Instance Groups", "type": "http" }, "http": { "method": "POST", "url": "/api/groups/overwrite", "body": { "type": "json", "data": "{}" } }, "docs": "Overwrite Instance Groups" }, { "info": { "name": "List Groups", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/groups/list", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query", "description": "which page to return (start at 1, default 1)" }, { "name": "per_page", "value": "", "type": "query", "description": "number of items to return for a given page (default 30, max 100)" } ] }, "docs": "List Groups" }, { "info": { "name": "List Group Names", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/groups/listnames", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "only_member_of", "value": "", "type": "query", "description": "only list the groups the user is member of (default false)" } ] }, "docs": "List Group Names" }, { "info": { "name": "Create Group", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/groups/create", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create Group" }, { "info": { "name": "Update Group", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/groups/update/:name", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "name", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update Group" }, { "info": { "name": "Delete Group", "type": "http" }, "http": { "method": "DELETE", "url": "/api/w/:workspace/groups/delete/:name", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "name", "value": "", "type": "path" } ] }, "docs": "Delete Group" }, { "info": { "name": "Get Group", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/groups/get/:name", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "name", "value": "", "type": "path" } ] }, "docs": "Get Group" }, { "info": { "name": "Add User to Group", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/groups/adduser/:name", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "name", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add User to Group" }, { "info": { "name": "Remove User to Group", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/groups/removeuser/:name", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "name", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Remove User to Group" }, { "info": { "name": "Get Group Permission History", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/groups_history/get/:name", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "name", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query", "description": "which page to return (start at 1, default 1)" }, { "name": "per_page", "value": "", "type": "query", "description": "number of items to return for a given page (default 30, max 100)" } ] }, "docs": "Get Group Permission History" } ] }, { "info": { "name": "folder", "type": "folder" }, "items": [ { "info": { "name": "List Folders", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/folders/list", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query", "description": "which page to return (start at 1, default 1)" }, { "name": "per_page", "value": "", "type": "query", "description": "number of items to return for a given page (default 30, max 100)" } ] }, "docs": "List Folders" }, { "info": { "name": "List Folder Names", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/folders/listnames", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "only_member_of", "value": "", "type": "query", "description": "only list the folders the user is member of (default false)" } ] }, "docs": "List Folder Names" }, { "info": { "name": "Create Folder", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/folders/create", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create Folder" }, { "info": { "name": "Update Folder", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/folders/update/:name", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "name", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update Folder" }, { "info": { "name": "Delete Folder", "type": "http" }, "http": { "method": "DELETE", "url": "/api/w/:workspace/folders/delete/:name", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "name", "value": "", "type": "path" } ] }, "docs": "Delete Folder" }, { "info": { "name": "Get Folder", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/folders/get/:name", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "name", "value": "", "type": "path" } ] }, "docs": "Get Folder" }, { "info": { "name": "Exists Folder", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/folders/exists/:name", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "name", "value": "", "type": "path" } ] }, "docs": "Exists Folder" }, { "info": { "name": "Get Folder Usage", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/folders/getusage/:name", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "name", "value": "", "type": "path" } ] }, "docs": "Get Folder Usage" }, { "info": { "name": "Add Owner to Folder", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/folders/addowner/:name", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "name", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add Owner to Folder" }, { "info": { "name": "Remove Owner to Folder", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/folders/removeowner/:name", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "name", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Remove Owner to Folder" }, { "info": { "name": "Get Folder Permission History", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/folders_history/get/:name", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "name", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query", "description": "which page to return (start at 1, default 1)" }, { "name": "per_page", "value": "", "type": "query", "description": "number of items to return for a given page (default 30, max 100)" } ] }, "docs": "Get Folder Permission History" } ] }, { "info": { "name": "config", "type": "folder" }, "items": [ { "info": { "name": "List Worker Groups", "type": "http" }, "http": { "method": "GET", "url": "/api/configs/list_worker_groups" }, "docs": "List Worker Groups" }, { "info": { "name": "Get Config", "type": "http" }, "http": { "method": "GET", "url": "/api/configs/get/:name", "params": [ { "name": "name", "value": "", "type": "path" } ] }, "docs": "Get Config" }, { "info": { "name": "Update Config", "type": "http" }, "http": { "method": "POST", "url": "/api/configs/update/:name", "params": [ { "name": "name", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update Config" }, { "info": { "name": "Delete Config", "type": "http" }, "http": { "method": "DELETE", "url": "/api/configs/update/:name", "params": [ { "name": "name", "value": "", "type": "path" } ] }, "docs": "Delete Config" }, { "info": { "name": "List Configs", "type": "http" }, "http": { "method": "GET", "url": "/api/configs/list" }, "docs": "List Configs" }, { "info": { "name": "List Autoscaling Events", "type": "http" }, "http": { "method": "GET", "url": "/api/configs/list_autoscaling_events/:worker_group", "params": [ { "name": "worker_group", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query", "description": "which page to return (start at 1, default 1)" }, { "name": "per_page", "value": "", "type": "query", "description": "number of items to return for a given page (default 30, max 100)" } ] }, "docs": "List Autoscaling Events" }, { "info": { "name": "Check Kubernetes Autoscaling Health for a Worker Group", "type": "http" }, "http": { "method": "GET", "url": "/api/configs/native_kubernetes_autoscaling_healthcheck" }, "docs": "Check Kubernetes Autoscaling Health for a Worker Group" }, { "info": { "name": "Get Currently Available Python Versions Provided by UV.", "type": "http" }, "http": { "method": "GET", "url": "/api/configs/list_available_python_versions" }, "docs": "Get Currently Available Python Versions Provided by UV." }, { "info": { "name": "List All Workspace Dependencies", "type": "http" }, "http": { "method": "GET", "url": "/api/configs/list_all_workspace_dependencies" }, "docs": "List All Workspace Dependencies" }, { "info": { "name": "List All Dedicated Scripts with Their Dependencies", "type": "http" }, "http": { "method": "GET", "url": "/api/configs/list_all_dedicated_with_deps" }, "docs": "List All Dedicated Scripts with Their Dependencies" } ] }, { "info": { "name": "agent_workers", "type": "folder" }, "items": [ { "info": { "name": "Create Agent Token", "type": "http" }, "http": { "method": "POST", "url": "/api/agent_workers/create_agent_token", "body": { "type": "json", "data": "{}" } }, "docs": "Create Agent Token" }, { "info": { "name": "Blacklist Agent Token (requires Super Admin)", "type": "http" }, "http": { "method": "POST", "url": "/api/agent_workers/blacklist_token", "body": { "type": "json", "data": "{}" } }, "docs": "Blacklist Agent Token (requires Super Admin)" }, { "info": { "name": "Remove Agent Token from Blacklist (requires Super Admin)", "type": "http" }, "http": { "method": "POST", "url": "/api/agent_workers/remove_blacklist_token", "body": { "type": "json", "data": "{}" } }, "docs": "Remove Agent Token from Blacklist (requires Super Admin)" }, { "info": { "name": "List Blacklisted Agent Tokens (requires Super Admin)", "type": "http" }, "http": { "method": "GET", "url": "/api/agent_workers/list_blacklisted_tokens", "params": [ { "name": "include_expired", "value": "", "type": "query", "description": "Whether to include expired blacklisted tokens" } ] }, "docs": "List Blacklisted Agent Tokens (requires Super Admin)" }, { "info": { "name": "Get Minimum Worker Version Across All Workers", "type": "http" }, "http": { "method": "GET", "url": "/api/agent_workers/get_min_version" }, "docs": "Get Minimum Worker Version Across All Workers" } ] }, { "info": { "name": "granular_acl", "type": "folder" }, "items": [ { "info": { "name": "Get Granular Acls", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/acls/get/:kind/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" }, { "name": "kind", "value": "", "type": "path" } ] }, "docs": "Get Granular Acls" }, { "info": { "name": "Add Granular Acls", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/acls/add/:kind/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" }, { "name": "kind", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add Granular Acls" }, { "info": { "name": "Remove Granular Acls", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/acls/remove/:kind/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" }, { "name": "kind", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Remove Granular Acls" } ] }, { "info": { "name": "capture", "type": "folder" }, "items": [ { "info": { "name": "Set Capture Config", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/capture/set_config", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Set Capture Config" }, { "info": { "name": "Ping Capture Config", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/capture/ping_config/:trigger_kind/:runnable_kind/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "trigger_kind", "value": "", "type": "path" }, { "name": "runnable_kind", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "Ping Capture Config" }, { "info": { "name": "Get Capture Configs for a Script or Flow", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/capture/get_configs/:runnable_kind/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "runnable_kind", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "Get Capture Configs for a Script or Flow" }, { "info": { "name": "List Captures for a Script or Flow", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/capture/list/:runnable_kind/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "runnable_kind", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" }, { "name": "trigger_kind", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query", "description": "which page to return (start at 1, default 1)" }, { "name": "per_page", "value": "", "type": "query", "description": "number of items to return for a given page (default 30, max 100)" } ] }, "docs": "List Captures for a Script or Flow" }, { "info": { "name": "Move Captures and Configs for a Script or Flow", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/capture/move/:runnable_kind/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "runnable_kind", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Move Captures and Configs for a Script or Flow" }, { "info": { "name": "Get a Capture", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/capture/:id", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get a Capture" }, { "info": { "name": "Delete a Capture", "type": "http" }, "http": { "method": "DELETE", "url": "/api/w/:workspace/capture/:id", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete a Capture" } ] }, { "info": { "name": "favorite", "type": "folder" }, "items": [ { "info": { "name": "Star Item", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/favorites/star", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Star Item" }, { "info": { "name": "Unstar Item", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/favorites/unstar", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Unstar Item" } ] }, { "info": { "name": "input", "type": "folder" }, "items": [ { "info": { "name": "List Inputs Used in Previously Completed Jobs", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/inputs/history", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "runnable_id", "value": "", "type": "query" }, { "name": "runnable_type", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query", "description": "which page to return (start at 1, default 1)" }, { "name": "per_page", "value": "", "type": "query", "description": "number of items to return for a given page (default 30, max 100)" }, { "name": "args", "value": "", "type": "query", "description": "filter on jobs containing those args as a json subset (@> in postgres)" }, { "name": "include_preview", "value": "", "type": "query" } ] }, "docs": "List Inputs Used in Previously Completed Jobs" }, { "info": { "name": "Get Args from History or Saved Input", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/inputs/:jobOrInputId/args", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "jobOrInputId", "value": "", "type": "path" }, { "name": "input", "value": "", "type": "query" }, { "name": "allow_large", "value": "", "type": "query" } ] }, "docs": "Get Args from History or Saved Input" }, { "info": { "name": "List Saved Inputs for a Runnable", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/inputs/list", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "runnable_id", "value": "", "type": "query" }, { "name": "runnable_type", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query", "description": "which page to return (start at 1, default 1)" }, { "name": "per_page", "value": "", "type": "query", "description": "number of items to return for a given page (default 30, max 100)" } ] }, "docs": "List Saved Inputs for a Runnable" }, { "info": { "name": "Create an Input for Future Use in a Script or Flow", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/inputs/create", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "runnable_id", "value": "", "type": "query" }, { "name": "runnable_type", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create an Input for Future Use in a Script or Flow" }, { "info": { "name": "Update an Input", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/inputs/update", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an Input" }, { "info": { "name": "Delete a Saved Input", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/inputs/delete/:input", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "input", "value": "", "type": "path" } ] }, "docs": "Delete a Saved Input" } ] }, { "info": { "name": "helpers", "type": "folder" }, "items": [ { "info": { "name": "Converts an S3 resource to the set of instructions necessary to connect DuckDB to an S3 bucket", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/job_helpers/duckdb_connection_settings", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Converts an S3 resource to the set of instructions necessary to connect DuckDB to an S3 bucket" }, { "info": { "name": "Converts an S3 resource to the set of instructions necessary to connect DuckDB to an S3 bucket", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/job_helpers/v2/duckdb_connection_settings", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Converts an S3 resource to the set of instructions necessary to connect DuckDB to an S3 bucket" }, { "info": { "name": "Converts an S3 resource to the set of arguments necessary to connect Polars to an S3 bucket", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/job_helpers/polars_connection_settings", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Converts an S3 resource to the set of arguments necessary to connect Polars to an S3 bucket" }, { "info": { "name": "Converts an S3 resource to the set of arguments necessary to connect Polars to an S3 bucket", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/job_helpers/v2/polars_connection_settings", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Converts an S3 resource to the set of arguments necessary to connect Polars to an S3 bucket" }, { "info": { "name": "Returns the S3 Resource Associated to the Provided Path, or the workspace default S3 resource", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/job_helpers/v2/s3_resource_info", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Returns the S3 Resource Associated to the Provided Path, or the workspace default S3 resource" }, { "info": { "name": "Test Connection to the Workspace Object Storage", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/job_helpers/test_connection", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "storage", "value": "", "type": "query" } ] }, "docs": "Test Connection to the Workspace Object Storage" }, { "info": { "name": "List the File Keys Available in a Workspace Object Storage", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/job_helpers/list_stored_files", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "max_keys", "value": "", "type": "query" }, { "name": "marker", "value": "", "type": "query" }, { "name": "prefix", "value": "", "type": "query" }, { "name": "storage", "value": "", "type": "query" } ] }, "docs": "List the File Keys Available in a Workspace Object Storage" }, { "info": { "name": "Load Metadata of the File", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/job_helpers/load_file_metadata", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "file_key", "value": "", "type": "query" }, { "name": "storage", "value": "", "type": "query" } ] }, "docs": "Load Metadata of the File" }, { "info": { "name": "Load a Preview of the File", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/job_helpers/load_file_preview", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "file_key", "value": "", "type": "query" }, { "name": "file_size_in_bytes", "value": "", "type": "query" }, { "name": "file_mime_type", "value": "", "type": "query" }, { "name": "csv_separator", "value": "", "type": "query" }, { "name": "csv_has_header", "value": "", "type": "query" }, { "name": "read_bytes_from", "value": "", "type": "query" }, { "name": "read_bytes_length", "value": "", "type": "query" }, { "name": "storage", "value": "", "type": "query" } ] }, "docs": "Load a Preview of the File" }, { "info": { "name": "List the File Keys Available in Instance Object Storage with Resource-based Access Control", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/job_helpers/list_git_repo_files", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "max_keys", "value": "", "type": "query" }, { "name": "marker", "value": "", "type": "query" }, { "name": "prefix", "value": "", "type": "query" }, { "name": "storage", "value": "", "type": "query" } ] }, "docs": "List the File Keys Available in Instance Object Storage with Resource-based Access Control" }, { "info": { "name": "Load a Preview of a File from Instance Storage with Resource-based Access Control", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/job_helpers/load_git_repo_file_preview", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "file_key", "value": "", "type": "query" }, { "name": "file_size_in_bytes", "value": "", "type": "query" }, { "name": "file_mime_type", "value": "", "type": "query" }, { "name": "csv_separator", "value": "", "type": "query" }, { "name": "csv_has_header", "value": "", "type": "query" }, { "name": "read_bytes_from", "value": "", "type": "query" }, { "name": "read_bytes_length", "value": "", "type": "query" }, { "name": "storage", "value": "", "type": "query" } ] }, "docs": "Load a Preview of a File from Instance Storage with Resource-based Access Control" }, { "info": { "name": "Load File Metadata from Instance Storage with Resource-based Access Control", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/job_helpers/load_git_repo_file_metadata", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "file_key", "value": "", "type": "query" }, { "name": "storage", "value": "", "type": "query" } ] }, "docs": "Load File Metadata from Instance Storage with Resource-based Access Control" }, { "info": { "name": "Check if S3 Path Exists and is a Folder", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/job_helpers/check_s3_folder_exists", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "file_key", "value": "", "type": "query", "description": "S3 file key to check (e.g., gitrepos/{workspace_id}/u/user/resource/{commit_hash})" }, { "name": "marker_file", "value": "", "type": "query", "description": "If provided, the folder is only considered to exist when this exact\nsentinel file is present under file_key. Lets callers distinguish a\nfully populated folder from a partial upload.\n" } ] }, "docs": "Check if S3 Path Exists and is a Folder" }, { "info": { "name": "Load a Preview of a Parquet File", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/job_helpers/load_parquet_preview/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" }, { "name": "offset", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "sort_col", "value": "", "type": "query" }, { "name": "sort_desc", "value": "", "type": "query" }, { "name": "search_col", "value": "", "type": "query" }, { "name": "search_term", "value": "", "type": "query" }, { "name": "storage", "value": "", "type": "query" } ] }, "docs": "Load a Preview of a Parquet File" }, { "info": { "name": "Load the Table Row Count", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/job_helpers/load_table_count/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" }, { "name": "search_col", "value": "", "type": "query" }, { "name": "search_term", "value": "", "type": "query" }, { "name": "storage", "value": "", "type": "query" } ] }, "docs": "Load the Table Row Count" }, { "info": { "name": "Load a Preview of a Csv File", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/job_helpers/load_csv_preview/:path", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" }, { "name": "offset", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "sort_col", "value": "", "type": "query" }, { "name": "sort_desc", "value": "", "type": "query" }, { "name": "search_col", "value": "", "type": "query" }, { "name": "search_term", "value": "", "type": "query" }, { "name": "storage", "value": "", "type": "query" }, { "name": "csv_separator", "value": "", "type": "query" } ] }, "docs": "Load a Preview of a Csv File" }, { "info": { "name": "Permanently Delete File from S3", "type": "http" }, "http": { "method": "DELETE", "url": "/api/w/:workspace/job_helpers/delete_s3_file", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "file_key", "value": "", "type": "query" }, { "name": "storage", "value": "", "type": "query" } ] }, "docs": "Permanently Delete File from S3" }, { "info": { "name": "Move a S3 File from One Path to the Other Within the Same Bucket", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/job_helpers/move_s3_file", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "src_file_key", "value": "", "type": "query" }, { "name": "dest_file_key", "value": "", "type": "query" }, { "name": "storage", "value": "", "type": "query" } ] }, "docs": "Move a S3 File from One Path to the Other Within the Same Bucket" }, { "info": { "name": "Upload File to S3 Bucket", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/job_helpers/upload_s3_file", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "file_key", "value": "", "type": "query" }, { "name": "file_extension", "value": "", "type": "query" }, { "name": "s3_resource_path", "value": "", "type": "query" }, { "name": "resource_type", "value": "", "type": "query" }, { "name": "storage", "value": "", "type": "query" }, { "name": "content_type", "value": "", "type": "query" }, { "name": "content_disposition", "value": "", "type": "query" } ] }, "docs": "Upload File to S3 Bucket" }, { "info": { "name": "Upload a File to the Instance Storage Gitrepos Section for Viewing", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/job_helpers/upload_git_repo_file_to_instance_storage", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "file_key", "value": "", "type": "query" }, { "name": "file_extension", "value": "", "type": "query" }, { "name": "s3_resource_path", "value": "", "type": "query" }, { "name": "resource_type", "value": "", "type": "query" }, { "name": "storage", "value": "", "type": "query" }, { "name": "content_type", "value": "", "type": "query" }, { "name": "content_disposition", "value": "", "type": "query" } ] }, "docs": "Upload a File to the Instance Storage Gitrepos Section for Viewing" }, { "info": { "name": "Download File from S3 Bucket", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/job_helpers/download_s3_file", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "file_key", "value": "", "type": "query" }, { "name": "s3_resource_path", "value": "", "type": "query" }, { "name": "resource_type", "value": "", "type": "query" }, { "name": "storage", "value": "", "type": "query" } ] }, "docs": "Download File from S3 Bucket" }, { "info": { "name": "Download File to S3 Bucket", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/job_helpers/download_s3_parquet_file_as_csv", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "file_key", "value": "", "type": "query" }, { "name": "s3_resource_path", "value": "", "type": "query" }, { "name": "resource_type", "value": "", "type": "query" } ] }, "docs": "Download File to S3 Bucket" } ] }, { "info": { "name": "metrics", "type": "folder" }, "items": [ { "info": { "name": "Get Job Metrics", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/job_metrics/get/:id", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Get Job Metrics" }, { "info": { "name": "Set Job Metrics", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/job_metrics/set_progress/:id", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Set Job Metrics" }, { "info": { "name": "Get Job Progress", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/job_metrics/get_progress/:id", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get Job Progress" } ] }, { "info": { "name": "service_logs", "type": "folder" }, "items": [ { "info": { "name": "List Log Files Ordered by Timestamp", "type": "http" }, "http": { "method": "GET", "url": "/api/service_logs/list_files", "params": [ { "name": "before", "value": "", "type": "query", "description": "filter on started before (inclusive) timestamp" }, { "name": "after", "value": "", "type": "query", "description": "filter on created after (exclusive) timestamp" }, { "name": "with_error", "value": "", "type": "query" } ] }, "docs": "List Log Files Ordered by Timestamp" }, { "info": { "name": "Get Log File by Path", "type": "http" }, "http": { "method": "GET", "url": "/api/service_logs/get_log_file/:path", "params": [ { "name": "path", "value": "", "type": "path" } ] }, "docs": "Get Log File by Path" } ] }, { "info": { "name": "concurrencyGroups", "type": "folder" }, "items": [ { "info": { "name": "List All Concurrency Groups", "type": "http" }, "http": { "method": "GET", "url": "/api/concurrency_groups/list" }, "docs": "List All Concurrency Groups" }, { "info": { "name": "Delete Concurrency Group", "type": "http" }, "http": { "method": "DELETE", "url": "/api/concurrency_groups/prune/:concurrency_id", "params": [ { "name": "concurrency_id", "value": "", "type": "path" } ] }, "docs": "Delete Concurrency Group" }, { "info": { "name": "Get the Concurrency Key for a Job that has Concurrency Limits Enabled", "type": "http" }, "http": { "method": "GET", "url": "/api/concurrency_groups/:id/key", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get the Concurrency Key for a Job that has Concurrency Limits Enabled" }, { "info": { "name": "Get Intervals of Job Runtime Concurrency", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/concurrency_groups/list_jobs", "params": [ { "name": "concurrency_key", "value": "", "type": "query" }, { "name": "row_limit", "value": "", "type": "query" }, { "name": "workspace", "value": "", "type": "path" }, { "name": "created_by", "value": "", "type": "query", "description": "filter by exact matching user creator. Supports comma-separated list (e.g. 'alice,bob') and negation by prefixing all values with '!' (e.g. '!alice,!bob')" }, { "name": "label", "value": "", "type": "query", "description": "filter by exact matching job label. Supports comma-separated list (e.g. 'deploy,release') and negation by prefixing all values with '!' (e.g. '!deploy,!release')" }, { "name": "parent_job", "value": "", "type": "query", "description": "The parent job that is at the origin and responsible for the execution of this script if any" }, { "name": "script_path_exact", "value": "", "type": "query", "description": "filter by exact matching script path. Supports comma-separated list (e.g. 'f/script1,f/script2') and negation by prefixing all values with '!' (e.g. '!f/script1,!f/script2')" }, { "name": "script_path_start", "value": "", "type": "query", "description": "filter by script path prefix. Supports comma-separated list (e.g. 'f/folder1,f/folder2') and negation by prefixing all values with '!' (e.g. '!f/folder1,!f/folder2')" }, { "name": "schedule_path", "value": "", "type": "query", "description": "mask to filter by schedule path" }, { "name": "script_hash", "value": "", "type": "query", "description": "mask to filter exact matching path" }, { "name": "started_before", "value": "", "type": "query", "description": "filter on started before (inclusive) timestamp" }, { "name": "started_after", "value": "", "type": "query", "description": "filter on started after (exclusive) timestamp" }, { "name": "running", "value": "", "type": "query", "description": "filter on running jobs" }, { "name": "scheduled_for_before_now", "value": "", "type": "query", "description": "filter on jobs scheduled_for before now (hence waitinf for a worker)" }, { "name": "completed_before", "value": "", "type": "query", "description": "filter on started before (inclusive) timestamp" }, { "name": "completed_after", "value": "", "type": "query", "description": "filter on started after (exclusive) timestamp" }, { "name": "created_before_queue", "value": "", "type": "query", "description": "filter on jobs created before X for jobs in the queue only" }, { "name": "created_after_queue", "value": "", "type": "query", "description": "filter on jobs created after X for jobs in the queue only" }, { "name": "job_kinds", "value": "", "type": "query", "description": "filter by job kind. Supports comma-separated list of values ('preview', 'script', 'dependencies', 'flow') and negation by prefixing all values with '!' (e.g. '!preview,!dependencies')" }, { "name": "args", "value": "", "type": "query", "description": "filter on jobs containing those args as a json subset (@> in postgres)" }, { "name": "tag", "value": "", "type": "query", "description": "filter by tag/worker group. Supports comma-separated list (e.g. 'gpu,highmem') and negation by prefixing all values with '!' (e.g. '!gpu,!highmem')" }, { "name": "result", "value": "", "type": "query", "description": "filter on jobs containing those result as a json subset (@> in postgres)" }, { "name": "allow_wildcards", "value": "", "type": "query", "description": "allow wildcards (*) in the filter of label, tag, worker" }, { "name": "page", "value": "", "type": "query", "description": "which page to return (start at 1, default 1)" }, { "name": "per_page", "value": "", "type": "query", "description": "number of items to return for a given page (default 30, max 100)" }, { "name": "trigger_kind", "value": "", "type": "query", "description": "filter by trigger kind. Supports comma-separated list (e.g. 'schedule,webhook') and negation by prefixing all values with '!' (e.g. '!schedule,!webhook')" }, { "name": "is_skipped", "value": "", "type": "query", "description": "is the job skipped" }, { "name": "is_flow_step", "value": "", "type": "query", "description": "is the job a flow step" }, { "name": "has_null_parent", "value": "", "type": "query", "description": "has null parent" }, { "name": "success", "value": "", "type": "query", "description": "filter on successful jobs" }, { "name": "all_workspaces", "value": "", "type": "query", "description": "get jobs from all workspaces (only valid if request come from the `admins` workspace)" }, { "name": "is_not_schedule", "value": "", "type": "query", "description": "is not a scheduled job" } ] }, "docs": "Get Intervals of Job Runtime Concurrency" } ] }, { "info": { "name": "indexSearch", "type": "folder" }, "items": [ { "info": { "name": "Search Through Jobs with a String Query", "type": "http" }, "http": { "method": "GET", "url": "/api/srch/w/:workspace/index/search/job", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "search_query", "value": "", "type": "query" }, { "name": "pagination_offset", "value": "", "type": "query" } ] }, "docs": "Search Through Jobs with a String Query" }, { "info": { "name": "Search Through Service Logs with a String Query", "type": "http" }, "http": { "method": "GET", "url": "/api/srch/index/search/service_logs", "params": [ { "name": "search_query", "value": "", "type": "query" }, { "name": "mode", "value": "", "type": "query" }, { "name": "worker_group", "value": "", "type": "query" }, { "name": "hostname", "value": "", "type": "query" }, { "name": "min_ts", "value": "", "type": "query" }, { "name": "max_ts", "value": "", "type": "query" } ] }, "docs": "Search Through Service Logs with a String Query" }, { "info": { "name": "Search and Count the Log Line Hits on Every Provided Host", "type": "http" }, "http": { "method": "GET", "url": "/api/srch/index/search/count_service_logs", "params": [ { "name": "search_query", "value": "", "type": "query" }, { "name": "min_ts", "value": "", "type": "query" }, { "name": "max_ts", "value": "", "type": "query" } ] }, "docs": "Search and Count the Log Line Hits on Every Provided Host" }, { "info": { "name": "Get Index Disk Storage Sizes from the Indexer.", "type": "http" }, "http": { "method": "GET", "url": "/api/srch/index/storage/disk" }, "docs": "Get Index Disk Storage Sizes from the Indexer." }, { "info": { "name": "Clear an Index and Restart the Indexer.", "type": "http" }, "http": { "method": "DELETE", "url": "/api/indexer/delete/:idx_name", "params": [ { "name": "idx_name", "value": "", "type": "path" } ] }, "docs": "Clear an Index and Restart the Indexer." }, { "info": { "name": "Get Index Storage Sizes (disk and S3).", "type": "http" }, "http": { "method": "GET", "url": "/api/indexer/storage" }, "docs": "Get Index Storage Sizes (disk and S3)." }, { "info": { "name": "Get Indexer Status Including Liveness and Storage Sizes.", "type": "http" }, "http": { "method": "GET", "url": "/api/indexer/status" }, "docs": "Get Indexer Status Including Liveness and Storage Sizes." } ] }, { "info": { "name": "asset", "type": "folder" }, "items": [ { "info": { "name": "List All Assets in the Workspace with Cursor Pagination", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/assets/list", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "per_page", "value": "", "type": "query", "description": "Number of items per page (max 1000, default 50)" }, { "name": "cursor_created_at", "value": "", "type": "query", "description": "Cursor timestamp for pagination (created_at of last item from previous page)" }, { "name": "cursor_id", "value": "", "type": "query", "description": "Cursor ID for pagination (id of last item from previous page)" }, { "name": "asset_path", "value": "", "type": "query", "description": "Filter by asset path (case-insensitive partial match)" }, { "name": "usage_path", "value": "", "type": "query", "description": "Filter by usage path (case-insensitive partial match)" }, { "name": "asset_kinds", "value": "", "type": "query", "description": "Filter by asset kinds (multiple values allowed)" }, { "name": "path", "value": "", "type": "query", "description": "exact path match filter" }, { "name": "columns", "value": "", "type": "query", "description": "JSONB subset match filter for columns using base64 encoded JSON" }, { "name": "broad_filter", "value": "", "type": "query", "description": "broad search across multiple fields (case-insensitive substring match)" } ] }, "docs": "List All Assets in the Workspace with Cursor Pagination" }, { "info": { "name": "List All Assets Used by Given Usages Paths", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/assets/list_by_usages", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "List All Assets Used by Given Usages Paths" }, { "info": { "name": "List All Favorite Assets for the Authenticated User", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/assets/list_favorites", "params": [ { "name": "workspace", "value": "", "type": "path" } ] }, "docs": "List All Favorite Assets for the Authenticated User" } ] }, { "info": { "name": "volume", "type": "folder" }, "items": [ { "info": { "name": "List All Volumes in the Workspace", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/volumes/list", "params": [ { "name": "workspace", "value": "", "type": "path" } ] }, "docs": "List All Volumes in the Workspace" }, { "info": { "name": "Get the Volume Storage Name (secondary Storage) or Null for Primary", "type": "http" }, "http": { "method": "GET", "url": "/api/w/:workspace/volumes/storage", "params": [ { "name": "workspace", "value": "", "type": "path" } ] }, "docs": "Get the Volume Storage Name (secondary Storage) or Null for Primary" }, { "info": { "name": "Create a New Volume", "type": "http" }, "http": { "method": "POST", "url": "/api/w/:workspace/volumes/create", "params": [ { "name": "workspace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a New Volume" }, { "info": { "name": "Delete a Volume (admin Only)", "type": "http" }, "http": { "method": "DELETE", "url": "/api/w/:workspace/volumes/delete/:name", "params": [ { "name": "workspace", "value": "", "type": "path" }, { "name": "name", "value": "", "type": "path" } ] }, "docs": "Delete a Volume (admin Only)" } ] }, { "info": { "name": "mcp", "type": "folder" }, "items": [ { "info": { "name": "List Available MCP Tools", "type": "http" }, "http": { "method": "GET", "url": "/api/mcp/w/:workspace/list_tools", "params": [ { "name": "workspace", "value": "", "type": "path" } ] }, "docs": "List Available MCP Tools" } ] }, { "info": { "name": "mcp_oauth", "type": "folder" }, "items": [ { "info": { "name": "Discover MCP Server OAuth Metadata", "type": "http" }, "http": { "method": "POST", "url": "/api/mcp/oauth/discover", "body": { "type": "json", "data": "{}" } }, "docs": "Discover MCP Server OAuth Metadata" }, { "info": { "name": "Start MCP OAuth Popup Flow", "type": "http" }, "http": { "method": "GET", "url": "/api/mcp/oauth/start", "params": [ { "name": "mcp_server_url", "value": "", "type": "query", "description": "URL of the MCP server to connect to" }, { "name": "scopes", "value": "", "type": "query", "description": "Comma-separated list of OAuth scopes to request" } ] }, "docs": "Opens in a popup, discovers OAuth metadata, registers client, and redirects to OAuth provider" }, { "info": { "name": "MCP OAuth Callback", "type": "http" }, "http": { "method": "GET", "url": "/api/mcp/oauth/callback", "params": [ { "name": "code", "value": "", "type": "query", "description": "OAuth authorization code" }, { "name": "state", "value": "", "type": "query", "description": "CSRF state token" } ] }, "docs": "Handles OAuth callback, exchanges code for tokens, returns HTML that posts message to opener" } ] } ], "bundled": true }