API

GET /apikey

List API keys

Responses

Status Code	Description
200	OK

POST /apikey/{apiKeyName}

Create an API key

Parameters

Name	Location	Required	Type	Description
apiKeyName	path	true	string	API key name

Responses

Status Code	Description
200	OK

DELETE /apikey/{apiKeyName}

Delete API key

Parameters

Name	Location	Required	Type	Description
apiKeyName	path	true	string	API key name

Responses

Status Code	Description
200	OK

GET /build

List builds

Responses

Status Code	Description
200	OK

POST /build

Create a build

Parameters

Name	Location	Required	Type	Description
createBuildDto	body	true	undefined	Create Build DTO

Responses

Status Code	Description
201	Created

DELETE /build

Delete ALL builds

Parameters

Name	Location	Required	Type	Description
force	query	undefined	boolean	Force

Responses

Status Code	Description
204	No Content

DELETE /build/prebuild/{prebuildId}

Delete builds

Parameters

Name	Location	Required	Type	Description
prebuildId	path	true	string	Prebuild ID
force	query	undefined	boolean	Force

Responses

Status Code	Description
204	No Content

GET /build/successful/{repoUrl}

List successful builds for Git repository

Parameters

Name	Location	Required	Type	Description
repoUrl	path	true	string	Repository URL

Responses

Status Code	Description
200	OK

GET /build/{buildId}

Find build

Parameters

Name	Location	Required	Type	Description
buildId	path	true	string	Build ID

Responses

Status Code	Description
200	OK

DELETE /build/{buildId}

Delete build

Parameters

Name	Location	Required	Type	Description
buildId	path	true	string	Build ID
force	query	undefined	boolean	Force

Responses

Status Code	Description
204	No Content

GET /container-registry/{server}

Find container registry

Parameters

Name	Location	Required	Type	Description
server	path	true	string	Container registry server
workspaceId	query	undefined	string	Workspace ID or Name

Responses

Status Code	Description
200	OK

GET /env

List environment variables

Responses

Status Code	Description
200	OK

PUT /env

Save environment variable

Parameters

Name	Location	Required	Type	Description
environmentVariable	body	true	undefined	Environment Variable

Responses

Status Code	Description
201	Created

DELETE /env/{key}

Delete environment variable

Parameters

Name	Location	Required	Type	Description
key	path	true	string	Environment Variable Key

Responses

Status Code	Description
204	No Content

GET /gitprovider

List Git providers

Responses

Status Code	Description
200	OK

PUT /gitprovider

Save Git provider

Parameters

Name	Location	Required	Type	Description
gitProviderConfig	body	true	undefined	Git provider

Responses

Status Code	Description
200	OK

POST /gitprovider/context

Get Git context

Parameters

Name	Location	Required	Type	Description
repository	body	true	undefined	Get repository context

Responses

Status Code	Description
200	OK

POST /gitprovider/context/url

Get URL from Git repository

Parameters

Name	Location	Required	Type	Description
repository	body	true	undefined	Git repository

Responses

Status Code	Description
200	OK

GET /gitprovider/for-url/{url}

List Git providers for url

Parameters

Name	Location	Required	Type	Description
url	path	true	string	Url

Responses

Status Code	Description
200	OK

GET /gitprovider/id-for-url/{url}

Find Git provider ID

Parameters

Name	Location	Required	Type	Description
url	path	true	string	Url

Responses

Status Code	Description
200	OK

GET /gitprovider/{gitProviderId}

Find Git provider

Parameters

Name	Location	Required	Type	Description
gitProviderId	path	true	string	ID

Responses

Status Code	Description
200	OK

DELETE /gitprovider/{gitProviderId}

Delete Git provider

Parameters

Name	Location	Required	Type	Description
gitProviderId	path	true	string	Git provider

Responses

Status Code	Description
200	OK

GET /gitprovider/{gitProviderId}/namespaces

Get Git namespaces

Parameters

Name	Location	Required	Type	Description
gitProviderId	path	true	string	Git provider
page	query	undefined	integer	Page number
per_page	query	undefined	integer	Number of items per page

Responses

Status Code	Description
200	OK

GET /gitprovider/{gitProviderId}/user

Get Git context

Parameters

Name	Location	Required	Type	Description
gitProviderId	path	true	string	Git Provider Id

Responses

Status Code	Description
200	OK

GET /gitprovider/{gitProviderId}/{namespaceId}/repositories

Get Git repositories

Parameters

Name	Location	Required	Type	Description
gitProviderId	path	true	string	Git provider
namespaceId	path	true	string	Namespace
page	query	undefined	integer	Page number
per_page	query	undefined	integer	Number of items per page

Responses

Status Code	Description
200	OK

GET /gitprovider/{gitProviderId}/{namespaceId}/{repositoryId}/branches

Get Git repository branches

Parameters

Name	Location	Required	Type	Description
gitProviderId	path	true	string	Git provider
namespaceId	path	true	string	Namespace
repositoryId	path	true	string	Repository
page	query	undefined	integer	Page number
per_page	query	undefined	integer	Number of items per page

Responses

Status Code	Description
200	OK

GET /gitprovider/{gitProviderId}/{namespaceId}/{repositoryId}/pull-requests

Get Git repository PRs

Parameters

Name	Location	Required	Type	Description
gitProviderId	path	true	string	Git provider
namespaceId	path	true	string	Namespace
repositoryId	path	true	string	Repository
page	query	undefined	integer	Page number
per_page	query	undefined	integer	Number of items per page

Responses

Status Code	Description
200	OK

GET /health

Health check

Responses

Status Code	Description
200	OK

GET /job

List jobs

Parameters

Name	Location	Required	Type	Description
states	query	undefined	array	Job States
actions	query	undefined	array	Job Actions
resourceId	query	undefined	string	Resource ID
resourceType	query	undefined	string	Resource Type

Responses

Status Code	Description
200	OK

GET /runner

List runners

Responses

Status Code	Description
200	OK

POST /runner

Create a runner

Parameters

Name	Location	Required	Type	Description
runner	body	true	undefined	Runner

Responses

Status Code	Description
200	OK

GET /runner/provider

List providers

Parameters

Name	Location	Required	Type	Description
runnerId	query	undefined	string	Runner ID

Responses

Status Code	Description
200	OK

GET /runner/provider/for-install

List providers available for installation

Responses

Status Code	Description
200	OK

GET /runner/{runnerId}

Find a runner

Parameters

Name	Location	Required	Type	Description
runnerId	path	true	string	Runner ID

Responses

Status Code	Description
200	OK

DELETE /runner/{runnerId}

Delete runner

Parameters

Name	Location	Required	Type	Description
runnerId	path	true	string	Runner ID

Responses

Status Code	Description
200	OK

GET /runner/{runnerId}/jobs

List runner jobs

Parameters

Name	Location	Required	Type	Description
runnerId	path	true	string	Runner ID

Responses

Status Code	Description
200	OK

POST /runner/{runnerId}/jobs/{jobId}/state

Update job state

Parameters

Name	Location	Required	Type	Description
runnerId	path	true	string	Runner ID
jobId	path	true	string	Job ID
updateJobState	body	true	undefined	Update job state

Responses

Status Code	Description
200	OK

POST /runner/{runnerId}/metadata

Update runner metadata

Parameters

Name	Location	Required	Type	Description
runnerId	path	true	string	Runner ID
runnerMetadata	body	true	undefined	Runner Metadata

Responses

Status Code	Description
200	OK

GET /runner/{runnerId}/provider

Get runner providers

Parameters

Name	Location	Required	Type	Description
runnerId	path	true	string	Runner ID

Responses

Status Code	Description
200	OK

POST /runner/{runnerId}/provider/{providerName}/install

Install provider

Parameters

Name	Location	Required	Type	Description
runnerId	path	true	string	Runner ID
providerName	path	true	string	Provider name
providerVersion	query	undefined	string	Provider version - defaults to ‘latest’

Responses

Status Code	Description
200	OK

POST /runner/{runnerId}/provider/{providerName}/uninstall

Uninstall provider

Parameters

Name	Location	Required	Type	Description
runnerId	path	true	string	Runner ID
providerName	path	true	string	Provider name

Responses

Status Code	Description
200	OK

POST /runner/{runnerId}/provider/{providerName}/update

Update provider

Parameters

Name	Location	Required	Type	Description
runnerId	path	true	string	Runner ID
providerName	path	true	string	Provider name
providerVersion	query	undefined	string	Provider version - defaults to ‘latest’

Responses

Status Code	Description
200	OK

GET /sample

List samples

Responses

Status Code	Description
200	OK

GET /server/config

Get the server configuration

Responses

Status Code	Description
200	OK

PUT /server/config

Save the server configuration

Parameters

Name	Location	Required	Type	Description
config	body	true	undefined	Server configuration

Responses

Status Code	Description
200	OK

GET /server/logs

Get server log files

Responses

Status Code	Description
200	OK

POST /server/network-key

Create a new authentication key

Responses

Status Code	Description
200	OK

GET /target

List targets

Parameters

Name	Location	Required	Type	Description
showOptions	query	undefined	boolean	Show target config options

Responses

Status Code	Description
200	OK

POST /target

Create a target

Parameters

Name	Location	Required	Type	Description
target	body	true	undefined	Create target

Responses

Status Code	Description
200	OK

GET /target-config

List target configs

Parameters

Name	Location	Required	Type	Description
showOptions	query	undefined	boolean	Show target config options

Responses

Status Code	Description
200	OK

POST /target-config

Create a target config

Parameters

Name	Location	Required	Type	Description
targetConfig	body	true	undefined	Target config to create
showOptions	query	undefined	boolean	Show target config options

Responses

Status Code	Description
200	OK

DELETE /target-config/{configId}

Delete a target config

Parameters

Name	Location	Required	Type	Description
configId	path	true	string	Target Config Id

Responses

Status Code	Description
204	No Content

GET /target/{targetId}

Find target

Parameters

Name	Location	Required	Type	Description
targetId	path	true	string	Target ID or Name
showOptions	query	undefined	boolean	Show target config options

Responses

Status Code	Description
200	OK

DELETE /target/{targetId}

Delete target

Parameters

Name	Location	Required	Type	Description
targetId	path	true	string	Target ID
force	query	undefined	boolean	Force

Responses

Status Code	Description
200	OK

POST /target/{targetId}/handle-successful-creation

Handles successful creation of the target

Parameters

Name	Location	Required	Type	Description
targetId	path	true	string	Target ID or name

Responses

Status Code	Description
200	OK

POST /target/{targetId}/metadata

Update target metadata

Parameters

Name	Location	Required	Type	Description
targetId	path	true	string	Target ID
targetMetadata	body	true	undefined	Target Metadata

Responses

Status Code	Description
200	OK

POST /target/{targetId}/provider-metadata

Update target provider metadata

Parameters

Name	Location	Required	Type	Description
targetId	path	true	string	Target ID
metadata	body	true	undefined	Provider metadata

Responses

Status Code	Description
200	OK

POST /target/{targetId}/restart

Restart target

Parameters

Name	Location	Required	Type	Description
targetId	path	true	string	Target ID or Name

Responses

Status Code	Description
200	OK

PATCH /target/{targetId}/set-default

Set target to be used by default

Parameters

Name	Location	Required	Type	Description
targetId	path	true	string	Target ID or name

Responses

Status Code	Description
200	OK

POST /target/{targetId}/start

Start target

Parameters

Name	Location	Required	Type	Description
targetId	path	true	string	Target ID or Name

Responses

Status Code	Description
200	OK

GET /target/{targetId}/state

Get target state

Parameters

Name	Location	Required	Type	Description
targetId	path	true	string	Target ID or Name

Responses

Status Code	Description
200	OK

POST /target/{targetId}/stop

Stop target

Parameters

Name	Location	Required	Type	Description
targetId	path	true	string	Target ID or Name

Responses

Status Code	Description
200	OK

GET /workspace

List workspaces

Parameters

Name	Location	Required	Type	Description
labels	query	undefined	string	JSON encoded labels

Responses

Status Code	Description
200	OK

POST /workspace

Create a workspace

Parameters

Name	Location	Required	Type	Description
workspace	body	true	undefined	Create workspace

Responses

Status Code	Description
200	OK

GET /workspace-template

List workspace templates

Responses

Status Code	Description
200	OK

PUT /workspace-template

Set workspace template data

Parameters

Name	Location	Required	Type	Description
workspaceTemplate	body	true	undefined	Workspace template

Responses

Status Code	Description
201	Created

GET /workspace-template/default/{gitUrl}

Get default workspace templates by git url

Parameters

Name	Location	Required	Type	Description
gitUrl	path	true	string	Git URL

Responses

Status Code	Description
200	OK

GET /workspace-template/prebuild

List prebuilds

Responses

Status Code	Description
200	OK

POST /workspace-template/prebuild/process-git-event

ProcessGitEvent

Parameters

Name	Location	Required	Type	Description
body	body	true	undefined	Webhook event

Responses

Status Code	Description
200	OK

GET /workspace-template/{templateName}

Find a workspace template

Parameters

Name	Location	Required	Type	Description
templateName	path	true	string	Template name

Responses

Status Code	Description
200	OK

DELETE /workspace-template/{templateName}

Delete workspace template data

Parameters

Name	Location	Required	Type	Description
templateName	path	true	string	Template name
force	query	undefined	boolean	Force

Responses

Status Code	Description
204	No Content

GET /workspace-template/{templateName}/prebuild

List prebuilds for workspace template

Parameters

Name	Location	Required	Type	Description
templateName	path	true	string	Template name

Responses

Status Code	Description
200	OK

PUT /workspace-template/{templateName}/prebuild

Save prebuild

Parameters

Name	Location	Required	Type	Description
templateName	path	true	string	Template name
prebuild	body	true	undefined	Prebuild

Responses

Status Code	Description
201	Created

GET /workspace-template/{templateName}/prebuild/{prebuildId}

Find prebuild

Parameters

Name	Location	Required	Type	Description
templateName	path	true	string	Workspace template name
prebuildId	path	true	string	Prebuild ID

Responses

Status Code	Description
200	OK

DELETE /workspace-template/{templateName}/prebuild/{prebuildId}

Delete prebuild

Parameters

Name	Location	Required	Type	Description
templateName	path	true	string	Workspace template name
prebuildId	path	true	string	Prebuild ID
force	query	undefined	boolean	Force

Responses

Status Code	Description
204	No Content

PATCH /workspace-template/{templateName}/set-default

Set workspace template to default

Parameters

Name	Location	Required	Type	Description
templateName	path	true	string	Template name

Responses

Status Code	Description
200	OK

GET /workspace/{workspaceId}

Find workspace

Parameters

Name	Location	Required	Type	Description
workspaceId	path	true	string	Workspace ID or Name

Responses

Status Code	Description
200	OK

DELETE /workspace/{workspaceId}

Delete workspace

Parameters

Name	Location	Required	Type	Description
workspaceId	path	true	string	Workspace ID
force	query	undefined	boolean	Force

Responses

Status Code	Description
200	OK

POST /workspace/{workspaceId}/labels

Update workspace labels

Parameters

Name	Location	Required	Type	Description
workspaceId	path	true	string	Workspace ID or Name
labels	body	true	undefined	Labels

Responses

Status Code	Description
200	OK

POST /workspace/{workspaceId}/metadata

Update workspace metadata

Parameters

Name	Location	Required	Type	Description
workspaceId	path	true	string	Workspace ID
workspaceMetadata	body	true	undefined	Workspace Metadata

Responses

Status Code	Description
200	OK

POST /workspace/{workspaceId}/provider-metadata

Update workspace provider metadata

Parameters

Name	Location	Required	Type	Description
workspaceId	path	true	string	Workspace ID
metadata	body	true	undefined	Provider metadata

Responses

Status Code	Description
200	OK

POST /workspace/{workspaceId}/restart

Restart workspace

Parameters

Name	Location	Required	Type	Description
workspaceId	path	true	string	Workspace ID or Name

Responses

Status Code	Description
200	OK

POST /workspace/{workspaceId}/start

Start workspace

Parameters

Name	Location	Required	Type	Description
workspaceId	path	true	string	Workspace ID or Name

Responses

Status Code	Description
200	OK

GET /workspace/{workspaceId}/state

Get workspace state

Parameters

Name	Location	Required	Type	Description
workspaceId	path	true	string	Workspace ID or Name

Responses

Status Code	Description
200	OK

POST /workspace/{workspaceId}/stop

Stop workspace

Parameters

Name	Location	Required	Type	Description
workspaceId	path	true	string	Workspace ID or Name

Responses

Status Code	Description
200	OK

GET /workspace/{workspaceId}/toolbox/files

List files inside a workspace

Parameters

Name	Location	Required	Type	Description
workspaceId	path	true	string	Workspace ID or Name
path	query	undefined	string	Path

Responses

Status Code	Description
200	OK

DELETE /workspace/{workspaceId}/toolbox/files

Delete file inside a workspace

Parameters

Name	Location	Required	Type	Description
workspaceId	path	true	string	Workspace ID or Name
path	query	true	string	Path

Responses

Status Code	Description
204	No Content

GET /workspace/{workspaceId}/toolbox/files/download

Download file from a workspace

Parameters

Name	Location	Required	Type	Description
workspaceId	path	true	string	Workspace ID or Name
path	query	true	string	Path

Responses

Status Code	Description
200	response contains the file

GET /workspace/{workspaceId}/toolbox/files/find

Search for text/pattern inside a workspace files

Parameters

Name	Location	Required	Type	Description
workspaceId	path	true	string	Workspace ID or Name
path	query	true	string	Path
pattern	query	true	string	Pattern

Responses

Status Code	Description
200	OK

POST /workspace/{workspaceId}/toolbox/files/folder

Create folder inside a workspace

Parameters

Name	Location	Required	Type	Description
workspaceId	path	true	string	Workspace ID or Name
path	query	true	string	Path
mode	query	true	string	Mode

Responses

Status Code	Description
201	Created

GET /workspace/{workspaceId}/toolbox/files/info

Get file info inside a workspace

Parameters

Name	Location	Required	Type	Description
workspaceId	path	true	string	Workspace ID or Name
path	query	true	string	Path

Responses

Status Code	Description
200	OK

POST /workspace/{workspaceId}/toolbox/files/move

Create folder inside a workspace

Parameters

Name	Location	Required	Type	Description
workspaceId	path	true	string	Workspace ID or Name
source	query	true	string	Source path
destination	query	true	string	Destination path

Responses

Status Code	Description
200	OK

POST /workspace/{workspaceId}/toolbox/files/permissions

Set file owner/group/permissions inside a workspace

Parameters

Name	Location	Required	Type	Description
workspaceId	path	true	string	Workspace ID or Name
path	query	true	string	Path
owner	query	undefined	string	Owner
group	query	undefined	string	Group
mode	query	undefined	string	Mode

Responses

Status Code	Description
200	OK

POST /workspace/{workspaceId}/toolbox/files/replace

Repleace text/pattern in mutilple files inside a workspace

Parameters

Name	Location	Required	Type	Description
workspaceId	path	true	string	Workspace ID or Name
replace	body	true	undefined	ReplaceParams

Responses

Status Code	Description
200	OK

GET /workspace/{workspaceId}/toolbox/files/search

Search for files inside a workspace

Parameters

Name	Location	Required	Type	Description
workspaceId	path	true	string	Workspace ID or Name
path	query	true	string	Path
pattern	query	true	string	Pattern

Responses

Status Code	Description
200	OK

POST /workspace/{workspaceId}/toolbox/files/upload

Upload file inside a workspace

Parameters

Name	Location	Required	Type	Description
workspaceId	path	true	string	Workspace ID or Name
path	query	true	string	Path
file	formData	true	file	File

Responses

Status Code	Description
200	OK

POST /workspace/{workspaceId}/toolbox/git/add

Add files to git commit

Parameters

Name	Location	Required	Type	Description
workspaceId	path	true	string	Workspace ID or Name
params	body	true	undefined	GitAddRequest

Responses

Status Code	Description
200	OK

GET /workspace/{workspaceId}/toolbox/git/branches

Get branch list from git repository inside a workspace

Parameters

Name	Location	Required	Type	Description
workspaceId	path	true	string	Workspace ID or Name
path	query	true	string	Path to git repository

Responses

Status Code	Description
200	OK

POST /workspace/{workspaceId}/toolbox/git/branches

Create branch on git repository inside a workspace

Parameters

Name	Location	Required	Type	Description
workspaceId	path	true	string	Workspace ID or Name
params	body	true	undefined	GitBranchRequest

Responses

Status Code	Description
201	Created

POST /workspace/{workspaceId}/toolbox/git/clone

Clone git repository inside a workspace

Parameters

Name	Location	Required	Type	Description
workspaceId	path	true	string	Workspace ID or Name
params	body	true	undefined	GitCloneRequest

Responses

Status Code	Description
200	OK

POST /workspace/{workspaceId}/toolbox/git/commit

Commit changes to git repository inside a workspace

Parameters

Name	Location	Required	Type	Description
workspaceId	path	true	string	Workspace ID or Name
params	body	true	undefined	GitCommitRequest

Responses

Status Code	Description
200	OK

GET /workspace/{workspaceId}/toolbox/git/history

Get commit history from git repository inside a workspace

Parameters

Name	Location	Required	Type	Description
workspaceId	path	true	string	Workspace ID or Name
path	query	true	string	Path to git repository

Responses

Status Code	Description
200	OK

POST /workspace/{workspaceId}/toolbox/git/pull

Pull changes from remote to git repository inside a workspace

Parameters

Name	Location	Required	Type	Description
workspaceId	path	true	string	Workspace ID or Name
params	body	true	undefined	Git pull request

Responses

Status Code	Description
200	OK

POST /workspace/{workspaceId}/toolbox/git/push

Push changes to remote from git repository inside a workspace

Parameters

Name	Location	Required	Type	Description
workspaceId	path	true	string	Workspace ID or Name
params	body	true	undefined	Git push request

Responses

Status Code	Description
200	OK

GET /workspace/{workspaceId}/toolbox/git/status

Get status from git repository inside a workspace

Parameters

Name	Location	Required	Type	Description
workspaceId	path	true	string	Workspace ID or Name
path	query	true	string	Path to git repository

Responses

Status Code	Description
200	OK

POST /workspace/{workspaceId}/toolbox/lsp/completions

The Completion request is sent from the client to the server to compute completion items at a given cursor position.

Parameters

Name	Location	Required	Type	Description
workspaceId	path	true	string	Workspace ID or Name
params	body	true	undefined	LspCompletionParams

Responses

Status Code	Description
200	OK

POST /workspace/{workspaceId}/toolbox/lsp/did-close

The document close notification is sent from the client to the server when the document got closed in the client.

Parameters

Name	Location	Required	Type	Description
workspaceId	path	true	string	Workspace ID or Name
params	body	true	undefined	LspDocumentRequest

Responses

Status Code	Description
200	OK

POST /workspace/{workspaceId}/toolbox/lsp/did-open

The document open notification is sent from the client to the server to signal newly opened text documents.

Parameters

Name	Location	Required	Type	Description
workspaceId	path	true	string	Workspace ID or Name
params	body	true	undefined	LspDocumentRequest

Responses

Status Code	Description
200	OK

GET /workspace/{workspaceId}/toolbox/lsp/document-symbols

The document symbol request is sent from the client to the server.

Parameters

Name	Location	Required	Type	Description
workspaceId	path	true	string	Workspace ID or Name
languageId	query	true	string	Language ID
pathToProject	query	true	string	Path to project
uri	query	true	string	Document Uri

Responses

Status Code	Description
200	OK

POST /workspace/{workspaceId}/toolbox/lsp/start

Start Lsp server process inside a workspace

Parameters

Name	Location	Required	Type	Description
workspaceId	path	true	string	Workspace ID or Name
params	body	true	undefined	LspServerRequest

Responses

Status Code	Description
200	OK

POST /workspace/{workspaceId}/toolbox/lsp/stop

Stop Lsp server process inside a workspace

Parameters

Name	Location	Required	Type	Description
workspaceId	path	true	string	Workspace ID or Name
params	body	true	undefined	LspServerRequest

Responses

Status Code	Description
200	OK

GET /workspace/{workspaceId}/toolbox/lsp/workspace-symbols

The workspace symbol request is sent from the client to the server to list project-wide symbols matching the query string.

Parameters

Name	Location	Required	Type	Description
workspaceId	path	true	string	Workspace ID or Name
languageId	query	true	string	Language ID
pathToProject	query	true	string	Path to project
query	query	true	string	Symbol Query

Responses

Status Code	Description
200	OK

POST /workspace/{workspaceId}/toolbox/process/execute

Execute command synchronously inside a workspace

Parameters

Name	Location	Required	Type	Description
workspaceId	path	true	string	Workspace ID or Name
params	body	true	undefined	Execute command request

Responses

Status Code	Description
200	OK

GET /workspace/{workspaceId}/toolbox/process/session

List sessions inside workspace project

Parameters

Name	Location	Required	Type	Description
workspaceId	path	true	string	Workspace ID or Name

Responses

Status Code	Description
200	OK

POST /workspace/{workspaceId}/toolbox/process/session

Create exec session inside workspace project

Parameters

Name	Location	Required	Type	Description
workspaceId	path	true	string	Workspace ID or Name
params	body	true	undefined	Create session request

Responses

Status Code	Description
201	Created

DELETE /workspace/{workspaceId}/toolbox/process/session/{sessionId}

Delete a session inside workspace project

Parameters

Name	Location	Required	Type	Description
workspaceId	path	true	string	Workspace ID or Name
sessionId	path	true	string	Session ID

Responses

Status Code	Description
204	No Content

GET /workspace/{workspaceId}/toolbox/process/session/{sessionId}/command/{commandId}/logs

Get logs of a command inside a session inside workspace project Connect with websocket to get a stream of the logs

Parameters

Name	Location	Required	Type	Description
workspaceId	path	true	string	Workspace ID or Name
sessionId	path	true	string	Session ID
commandId	path	true	string	Command ID

Responses

Status Code	Description
200	command logs

POST /workspace/{workspaceId}/toolbox/process/session/{sessionId}/exec

Execute command inside a session inside workspace project

Parameters

Name	Location	Required	Type	Description
workspaceId	path	true	string	Workspace ID or Name
sessionId	path	true	string	Session ID
params	body	true	undefined	Execute command request

Responses

Status Code	Description
200	OK

GET /workspace/{workspaceId}/toolbox/workspace-dir

Get workspace directory

Parameters

Name	Location	Required	Type	Description
workspaceId	path	true	string	Workspace ID or Name

Responses

Status Code	Description
200	OK