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

x/windmill/windmill-api/WorkerApi.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

.WorkerApi

All URIs are relative to /api

Method HTTP request Description
listWorkers GET /workers/list list workers

listWorkers

Array listWorkers()

Example

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

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

let body:.WorkerApiListWorkersRequest = {
  // 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,
};

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

Parameters

Name Type Description Notes
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

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 a list of workers -

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