Skip to main content
Deno 2 is finally here 🎉️
Learn more
Module

x/windmill/windmill-api/FlowApi.md

Windmill deno client (separated from the main repo because most of the code is auto-generated from the openapi and not worth committing)
Go to Latest
File

.FlowApi

All URIs are relative to /api

Method HTTP request Description
archiveFlowByPath POST /w/{workspace}/flows/archive/{path} archive flow by path
createFlow POST /w/{workspace}/flows/create create flow
existsFlowByPath GET /w/{workspace}/flows/exists/{path} exists flow by path
getFlowByPath GET /w/{workspace}/flows/get/{path} get flow by path
getHubFlowById GET /flows/hub/get/{id} get hub flow by id
listFlows GET /w/{workspace}/flows/list list all available flows
listHubFlows GET /flows/hub/list list all available hub flows
updateFlow POST /w/{workspace}/flows/update/{path} update flow

archiveFlowByPath

string archiveFlowByPath()

Example

import {  } from '';
import * as fs from 'fs';

const configuration = .createConfiguration();
const apiInstance = new .FlowApi(configuration);

let body:.FlowApiArchiveFlowByPathRequest = {
  // string
  workspace: "workspace_example",
  // string
  path: "path_example",
};

apiInstance.archiveFlowByPath(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

Name Type Description Notes
workspace [string] defaults to undefined
path [string] defaults to undefined

Return type

string

Authorization

bearerAuth, cookieAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain

HTTP response details

Status code Description Response headers
200 flow archived -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createFlow

string createFlow(openFlowWPath)

Example

import {  } from '';
import * as fs from 'fs';

const configuration = .createConfiguration();
const apiInstance = new .FlowApi(configuration);

let body:.FlowApiCreateFlowRequest = {
  // string
  workspace: "workspace_example",
  // OpenFlowWPath | Partially filled flow
  openFlowWPath: null,
};

apiInstance.createFlow(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

Name Type Description Notes
openFlowWPath OpenFlowWPath Partially filled flow
workspace [string] defaults to undefined

Return type

string

Authorization

bearerAuth, cookieAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: text/plain

HTTP response details

Status code Description Response headers
201 flow created -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

existsFlowByPath

boolean existsFlowByPath()

Example

import {  } from '';
import * as fs from 'fs';

const configuration = .createConfiguration();
const apiInstance = new .FlowApi(configuration);

let body:.FlowApiExistsFlowByPathRequest = {
  // string
  workspace: "workspace_example",
  // string
  path: "path_example",
};

apiInstance.existsFlowByPath(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

Name Type Description Notes
workspace [string] defaults to undefined
path [string] defaults to undefined

Return type

boolean

Authorization

bearerAuth, cookieAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 flow details -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getFlowByPath

Flow getFlowByPath()

Example

import {  } from '';
import * as fs from 'fs';

const configuration = .createConfiguration();
const apiInstance = new .FlowApi(configuration);

let body:.FlowApiGetFlowByPathRequest = {
  // string
  workspace: "workspace_example",
  // string
  path: "path_example",
};

apiInstance.getFlowByPath(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

Name Type Description Notes
workspace [string] defaults to undefined
path [string] defaults to undefined

Return type

Flow

Authorization

bearerAuth, cookieAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 flow details -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getHubFlowById

InlineResponse2004 getHubFlowById()

Example

import {  } from '';
import * as fs from 'fs';

const configuration = .createConfiguration();
const apiInstance = new .FlowApi(configuration);

let body:.FlowApiGetHubFlowByIdRequest = {
  // number
  id: 1,
};

apiInstance.getHubFlowById(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

Name Type Description Notes
id [number] defaults to undefined

Return type

InlineResponse2004

Authorization

bearerAuth, cookieAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 flow -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

listFlows

Array listFlows()

Example

import {  } from '';
import * as fs from 'fs';

const configuration = .createConfiguration();
const apiInstance = new .FlowApi(configuration);

let body:.FlowApiListFlowsRequest = {
  // string
  workspace: "workspace_example",
  // number | which page to return (start at 1, default 1) (optional)
  page: 1,
  // number | number of items to return for a given page (default 30, max 100) (optional)
  perPage: 1,
  // boolean | order by desc order (default true) (optional)
  orderDesc: true,
  // string | mask to filter exact matching user creator (optional)
  createdBy: "created_by_example",
  // string | mask to filter matching starting path (optional)
  pathStart: "path_start_example",
  // string | mask to filter exact matching path (optional)
  pathExact: "path_exact_example",
  // boolean | (default false) show also the archived files. when multiple archived hash share the same path, only the ones with the latest create_at are displayed.  (optional)
  showArchived: true,
};

apiInstance.listFlows(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

Name Type Description Notes
workspace [string] defaults to undefined
page [number] which page to return (start at 1, default 1) (optional) defaults to undefined
perPage [number] number of items to return for a given page (default 30, max 100) (optional) defaults to undefined
orderDesc [boolean] order by desc order (default true) (optional) defaults to undefined
createdBy [string] mask to filter exact matching user creator (optional) defaults to undefined
pathStart [string] mask to filter matching starting path (optional) defaults to undefined
pathExact [string] mask to filter exact matching path (optional) defaults to undefined
showArchived [boolean] (default false) show also the archived files. when multiple archived hash share the same path, only the ones with the latest create_at are displayed. (optional) defaults to undefined

Return type

Array

Authorization

bearerAuth, cookieAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 All available flow -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

listHubFlows

InlineResponse2003 listHubFlows()

Example

import {  } from '';
import * as fs from 'fs';

const configuration = .createConfiguration();
const apiInstance = new .FlowApi(configuration);

let body:any = {};

apiInstance.listHubFlows(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

This endpoint does not need any parameter.

Return type

InlineResponse2003

Authorization

bearerAuth, cookieAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 hub flows list -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateFlow

string updateFlow(openFlowWPath)

Example

import {  } from '';
import * as fs from 'fs';

const configuration = .createConfiguration();
const apiInstance = new .FlowApi(configuration);

let body:.FlowApiUpdateFlowRequest = {
  // string
  workspace: "workspace_example",
  // string
  path: "path_example",
  // OpenFlowWPath | Partially filled flow
  openFlowWPath: null,
};

apiInstance.updateFlow(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

Name Type Description Notes
openFlowWPath OpenFlowWPath Partially filled flow
workspace [string] defaults to undefined
path [string] defaults to undefined

Return type

string

Authorization

bearerAuth, cookieAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: text/plain

HTTP response details

Status code Description Response headers
200 flow updated -

[Back to top] [Back to API list] [Back to Model list] [Back to README]