API

GET /apikey

List API keys

Responses

Status Code	Description
200	OK

POST /apikey/{apiKeyName}

Generate 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}

Revoke 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/{buildId}

Get build data

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

List container registries

Responses

Status Code	Description
200	OK

GET /container-registry/{server}

Get container registry credentials

Parameters

Name	Location	Required	Type	Description
server	path	true	string	Container Registry server name

Responses

Status Code	Description
200	OK

PUT /container-registry/{server}

Set container registry credentials

Parameters

Name	Location	Required	Type	Description
server	path	true	string	Container Registry server name
containerRegistry	body	true	undefined	Container Registry credentials to set

Responses

Status Code	Description
201	Created

DELETE /container-registry/{server}

Remove a container registry credentials

Parameters

Name	Location	Required	Type	Description
server	path	true	string	Container Registry server name

Responses

Status Code	Description
204	No Content

GET /gitprovider

List Git providers

Responses

Status Code	Description
200	OK

PUT /gitprovider

Set 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}

Get Git provider ID

Parameters

Name	Location	Required	Type	Description
url	path	true	string	Url

Responses

Status Code	Description
200	OK

GET /gitprovider/{gitProviderId}

Get Git provider

Parameters

Name	Location	Required	Type	Description
gitProviderId	path	true	string	ID

Responses

Status Code	Description
200	OK

DELETE /gitprovider/{gitProviderId}

Remove 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 /profile

Get profile data

Responses

Status Code	Description
200	OK

PUT /profile

Set profile data

Parameters

Name	Location	Required	Type	Description
profileData	body	true	undefined	Profile data

Responses

Status Code	Description
201	Created

DELETE /profile

Delete profile data

Responses

Status Code	Description
204	No Content

GET /project-config

List project configs

Responses

Status Code	Description
200	OK

PUT /project-config

Set project config data

Parameters

Name	Location	Required	Type	Description
projectConfig	body	true	undefined	Project config

Responses

Status Code	Description
201	Created

GET /project-config/default/{gitUrl}

Get project configs by git url

Parameters

Name	Location	Required	Type	Description
gitUrl	path	true	string	Git URL

Responses

Status Code	Description
200	OK

GET /project-config/prebuild

List prebuilds

Responses

Status Code	Description
200	OK

POST /project-config/prebuild/process-git-event

ProcessGitEvent

Parameters

Name	Location	Required	Type	Description
workspace	body	true	undefined	Webhook event

Responses

Status Code	Description
200	OK

GET /project-config/{configName}

Get project config data

Parameters

Name	Location	Required	Type	Description
configName	path	true	string	Config name

Responses

Status Code	Description
200	OK

DELETE /project-config/{configName}

Delete project config data

Parameters

Name	Location	Required	Type	Description
configName	path	true	string	Config name
force	query	undefined	boolean	Force

Responses

Status Code	Description
204	No Content

GET /project-config/{configName}/prebuild

List prebuilds for project config

Parameters

Name	Location	Required	Type	Description
configName	path	true	string	Config name

Responses

Status Code	Description
200	OK

PUT /project-config/{configName}/prebuild

Set prebuild

Parameters

Name	Location	Required	Type	Description
configName	path	true	string	Config name
prebuild	body	true	undefined	Prebuild

Responses

Status Code	Description
201	Created

GET /project-config/{configName}/prebuild/{prebuildId}

Get prebuild

Parameters

Name	Location	Required	Type	Description
configName	path	true	string	Project config name
prebuildId	path	true	string	Prebuild ID

Responses

Status Code	Description
200	OK

DELETE /project-config/{configName}/prebuild/{prebuildId}

Delete prebuild

Parameters

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

Responses

Status Code	Description
204	No Content

PATCH /project-config/{configName}/set-default

Set project config to default

Parameters

Name	Location	Required	Type	Description
configName	path	true	string	Config name

Responses

Status Code	Description
200	OK

GET /provider

List providers

Responses

Status Code	Description
200	OK

POST /provider/install

Install a provider

Parameters

Name	Location	Required	Type	Description
provider	body	true	undefined	Provider to install

Responses

Status Code	Description
200	OK

GET /provider/{provider}/target-manifest

Get provider target manifest

Parameters

Name	Location	Required	Type	Description
provider	path	true	string	Provider name

Responses

Status Code	Description
200	OK

POST /provider/{provider}/uninstall

Uninstall a provider

Parameters

Name	Location	Required	Type	Description
provider	path	true	string	Provider to uninstall

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

POST /server/config

Set the server configuration

Parameters

Name	Location	Required	Type	Description
config	body	true	undefined	Server configuration

Responses

Status Code	Description
200	OK

GET /server/logs

List server log files

Responses

Status Code	Description
200	OK

POST /server/network-key

Generate a new authentication key

Responses

Status Code	Description
200	OK

GET /target

List targets

Responses

Status Code	Description
200	OK

PUT /target

Set a target

Parameters

Name	Location	Required	Type	Description
target	body	true	undefined	Target to set

Responses

Status Code	Description
201	Created

DELETE /target/{target}

Remove a target

Parameters

Name	Location	Required	Type	Description
target	path	true	string	Target name

Responses

Status Code	Description
204	No Content

PATCH /target/{target}/set-default

Set target to default

Parameters

Name	Location	Required	Type	Description
target	path	true	string	Target name

Responses

Status Code	Description
200	OK

GET /workspace

List workspaces

Parameters

Name	Location	Required	Type	Description
verbose	query	undefined	boolean	Verbose

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/{workspaceId}

Get workspace info

Parameters

Name	Location	Required	Type	Description
workspaceId	path	true	string	Workspace ID or Name
verbose	query	undefined	boolean	Verbose

Responses

Status Code	Description
200	OK

DELETE /workspace/{workspaceId}

Remove 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}/start

Start workspace

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

POST /workspace/{workspaceId}/{projectId}/start

Start project

Parameters

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

Responses

Status Code	Description
200	OK

POST /workspace/{workspaceId}/{projectId}/state

Set project state

Parameters

Name	Location	Required	Type	Description
workspaceId	path	true	string	Workspace ID or Name
projectId	path	true	string	Project ID
setState	body	true	undefined	Set State

Responses

Status Code	Description
200	OK

POST /workspace/{workspaceId}/{projectId}/stop

Stop project

Parameters

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

Responses

Status Code	Description
200	OK

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

List files inside workspace project

Parameters

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

Responses

Status Code	Description
200	OK

DELETE /workspace/{workspaceId}/{projectId}/toolbox/files

Delete file inside workspace project

Parameters

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

Responses

Status Code	Description
204	No Content

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

Download file from workspace project

Parameters

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

Responses

Status Code	Description
200	response contains the file

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

Search for text/pattern inside workspace project files

Parameters

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

Responses

Status Code	Description
200	OK

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

Create folder inside workspace project

Parameters

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

Responses

Status Code	Description
201	Created

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

Get file info inside workspace project

Parameters

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

Responses

Status Code	Description
200	OK

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

Create folder inside workspace project

Parameters

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

Responses

Status Code	Description
200	OK

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

Set file owner/group/permissions inside workspace project

Parameters

Name	Location	Required	Type	Description
workspaceId	path	true	string	Workspace ID or Name
projectId	path	true	string	Project ID
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}/{projectId}/toolbox/files/replace

Repleace text/pattern in mutilple files inside workspace project

Parameters

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

Responses

Status Code	Description
200	OK

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

Search for files inside workspace project

Parameters

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

Responses

Status Code	Description
200	OK

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

Upload file inside workspace project

Parameters

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

Responses

Status Code	Description
200	OK

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

Add files to git commit

Parameters

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

Responses

Status Code	Description
200	OK

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

Get branch list from git repository inside workspace project

Parameters

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

Responses

Status Code	Description
200	OK

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

Create branch on git repository inside workspace project

Parameters

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

Responses

Status Code	Description
201	Created

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

Clone git repository inside workspace project

Parameters

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

Responses

Status Code	Description
200	OK

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

Commit changes to git repository inside workspace project

Parameters

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

Responses

Status Code	Description
200	OK

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

Get commit history from git repository inside workspace project

Parameters

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

Responses

Status Code	Description
200	OK

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

Pull changes from remote to git repository inside workspace project

Parameters

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

Responses

Status Code	Description
200	OK

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

Push changes to remote from git repository inside workspace project

Parameters

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

Responses

Status Code	Description
200	OK

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

Get status from git repository inside workspace project

Parameters

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

Responses

Status Code	Description
200	OK

POST /workspace/{workspaceId}/{projectId}/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
projectId	path	true	string	Project ID
params	body	true	undefined	LspCompletionParams

Responses

Status Code	Description
200	OK

POST /workspace/{workspaceId}/{projectId}/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
projectId	path	true	string	Project ID
params	body	true	undefined	LspDocumentRequest

Responses

Status Code	Description
200	OK

POST /workspace/{workspaceId}/{projectId}/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
projectId	path	true	string	Project ID
params	body	true	undefined	LspDocumentRequest

Responses

Status Code	Description
200	OK

GET /workspace/{workspaceId}/{projectId}/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
projectId	path	true	string	Project ID
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}/{projectId}/toolbox/lsp/start

Start Lsp server process inside workspace project

Parameters

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

Responses

Status Code	Description
200	OK

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

Stop Lsp server process inside workspace project

Parameters

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

Responses

Status Code	Description
200	OK

GET /workspace/{workspaceId}/{projectId}/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
projectId	path	true	string	Project ID
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}/{projectId}/toolbox/process/execute

Execute command synchronously inside workspace project

Parameters

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

Responses

Status Code	Description
200	OK

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

Get project directory

Parameters

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

Responses

Status Code	Description
200	OK