x/windmill/windmill-api/WorkspaceApi.md
.WorkspaceApi
All URIs are relative to /api
Method | HTTP request | Description |
---|---|---|
createWorkspace | POST /workspaces/create | create workspace |
deleteInvite | POST /w/{workspace}/workspaces/delete_invite | delete user invite |
deleteWorkspace | DELETE /w/{workspace}/workspaces/delete | delete workspace |
editSlackCommand | POST /w/{workspace}/workspaces/edit_slack_command | edit slack command |
existsUsername | POST /workspaces/exists_username | exists username |
existsWorkspace | POST /workspaces/exists | exists workspace |
getSettings | GET /w/{workspace}/workspaces/get_settings | get settings |
inviteUser | POST /w/{workspace}/workspaces/invite_user | invite user to workspace |
listPendingInvites | GET /w/{workspace}/workspaces/list_pending_invites | list pending invites for a workspace |
listUserWorkspaces | GET /workspaces/users | list all workspaces visible to me with user info |
listWorkspaces | GET /workspaces/list | list all workspaces visible to me |
listWorkspacesAsSuperAdmin | GET /workspaces/list_as_superadmin | list all workspaces as super admin (require to be super admin) |
createWorkspace
string createWorkspace(createWorkspace)
Example
import { } from '';
import * as fs from 'fs';
const configuration = .createConfiguration();
const apiInstance = new .WorkspaceApi(configuration);
let body:.WorkspaceApiCreateWorkspaceRequest = {
// CreateWorkspace | new token
createWorkspace: {
id: "id_example",
name: "name_example",
username: "username_example",
domain: "domain_example",
},
};
apiInstance.createWorkspace(body).then((data:any) => {
console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));
Parameters
Name | Type | Description | Notes |
---|---|---|---|
createWorkspace | CreateWorkspace | new token |
Return type
string
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: text/plain
HTTP response details
Status code | Description | Response headers |
---|---|---|
201 | token created | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
deleteInvite
string deleteInvite(inlineObject8)
Example
import { } from '';
import * as fs from 'fs';
const configuration = .createConfiguration();
const apiInstance = new .WorkspaceApi(configuration);
let body:.WorkspaceApiDeleteInviteRequest = {
// string
workspace: "workspace_example",
// InlineObject8
inlineObject8: {
email: "email_example",
isAdmin: true,
},
};
apiInstance.deleteInvite(body).then((data:any) => {
console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));
Parameters
Name | Type | Description | Notes |
---|---|---|---|
inlineObject8 | InlineObject8 | ||
workspace | [string] | defaults to undefined |
Return type
string
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: text/plain
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | status | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
deleteWorkspace
string deleteWorkspace()
Example
import { } from '';
import * as fs from 'fs';
const configuration = .createConfiguration();
const apiInstance = new .WorkspaceApi(configuration);
let body:.WorkspaceApiDeleteWorkspaceRequest = {
// string
workspace: "workspace_example",
};
apiInstance.deleteWorkspace(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 |
Return type
string
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: text/plain
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | status | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
editSlackCommand
string editSlackCommand(inlineObject9)
Example
import { } from '';
import * as fs from 'fs';
const configuration = .createConfiguration();
const apiInstance = new .WorkspaceApi(configuration);
let body:.WorkspaceApiEditSlackCommandRequest = {
// string
workspace: "workspace_example",
// InlineObject9
inlineObject9: {
slackCommandScript: "slackCommandScript_example",
},
};
apiInstance.editSlackCommand(body).then((data:any) => {
console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));
Parameters
Name | Type | Description | Notes |
---|---|---|---|
inlineObject9 | InlineObject9 | ||
workspace | [string] | defaults to undefined |
Return type
string
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: text/plain
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | status | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
existsUsername
boolean existsUsername(inlineObject4)
Example
import { } from '';
import * as fs from 'fs';
const configuration = .createConfiguration();
const apiInstance = new .WorkspaceApi(configuration);
let body:.WorkspaceApiExistsUsernameRequest = {
// InlineObject4
inlineObject4: {
id: "id_example",
username: "username_example",
},
};
apiInstance.existsUsername(body).then((data:any) => {
console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));
Parameters
Name | Type | Description | Notes |
---|---|---|---|
inlineObject4 | InlineObject4 |
Return type
boolean
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: text/plain
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | status | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
existsWorkspace
boolean existsWorkspace(inlineObject3)
Example
import { } from '';
import * as fs from 'fs';
const configuration = .createConfiguration();
const apiInstance = new .WorkspaceApi(configuration);
let body:.WorkspaceApiExistsWorkspaceRequest = {
// InlineObject3
inlineObject3: {
id: "id_example",
},
};
apiInstance.existsWorkspace(body).then((data:any) => {
console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));
Parameters
Name | Type | Description | Notes |
---|---|---|---|
inlineObject3 | InlineObject3 |
Return type
boolean
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: text/plain
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | status | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getSettings
InlineResponse200 getSettings()
Example
import { } from '';
import * as fs from 'fs';
const configuration = .createConfiguration();
const apiInstance = new .WorkspaceApi(configuration);
let body:.WorkspaceApiGetSettingsRequest = {
// string
workspace: "workspace_example",
};
apiInstance.getSettings(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 |
Return type
InlineResponse200
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | status | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
inviteUser
string inviteUser(inlineObject7)
Example
import { } from '';
import * as fs from 'fs';
const configuration = .createConfiguration();
const apiInstance = new .WorkspaceApi(configuration);
let body:.WorkspaceApiInviteUserRequest = {
// string
workspace: "workspace_example",
// InlineObject7
inlineObject7: {
email: "email_example",
isAdmin: true,
},
};
apiInstance.inviteUser(body).then((data:any) => {
console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));
Parameters
Name | Type | Description | Notes |
---|---|---|---|
inlineObject7 | InlineObject7 | ||
workspace | [string] | defaults to undefined |
Return type
string
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: text/plain
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | status | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
listPendingInvites
Array listPendingInvites()
Example
import { } from '';
import * as fs from 'fs';
const configuration = .createConfiguration();
const apiInstance = new .WorkspaceApi(configuration);
let body:.WorkspaceApiListPendingInvitesRequest = {
// string
workspace: "workspace_example",
};
apiInstance.listPendingInvites(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 |
Return type
Array
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | user | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
listUserWorkspaces
UserWorkspaceList listUserWorkspaces()
Example
import { } from '';
import * as fs from 'fs';
const configuration = .createConfiguration();
const apiInstance = new .WorkspaceApi(configuration);
let body:any = {};
apiInstance.listUserWorkspaces(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
UserWorkspaceList
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | workspace with associated username | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
listWorkspaces
Array listWorkspaces()
Example
import { } from '';
import * as fs from 'fs';
const configuration = .createConfiguration();
const apiInstance = new .WorkspaceApi(configuration);
let body:any = {};
apiInstance.listWorkspaces(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
Array
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | all workspaces | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
listWorkspacesAsSuperAdmin
Array listWorkspacesAsSuperAdmin()
Example
import { } from '';
import * as fs from 'fs';
const configuration = .createConfiguration();
const apiInstance = new .WorkspaceApi(configuration);
let body:.WorkspaceApiListWorkspacesAsSuperAdminRequest = {
// 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.listWorkspacesAsSuperAdmin(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
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | workspaces | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]