Skip to content

API

POST /docker-registry

Responses

Status CodeDescription
201The docker registry has been successfully created.

GET /docker-registry

Responses

Status CodeDescription
200List of all docker registries

GET /docker-registry/registry-push-access

Responses

Status CodeDescription
200Temporary registry access has been generated

GET /docker-registry/{id}

Parameters

NameLocationRequiredTypeDescription
idpathtrueundefinedundefined

Responses

Status CodeDescription
200The docker registry

PATCH /docker-registry/{id}

Parameters

NameLocationRequiredTypeDescription
idpathtrueundefinedundefined

Responses

Status CodeDescription
200The docker registry has been successfully updated.

DELETE /docker-registry/{id}

Parameters

NameLocationRequiredTypeDescription
idpathtrueundefinedundefined

Responses

Status CodeDescription
204The docker registry has been successfully deleted.

POST /docker-registry/{id}/set-default

Parameters

NameLocationRequiredTypeDescription
idpathtrueundefinedundefined

Responses

Status CodeDescription
200The docker registry has been set as default.

POST /api-keys

Responses

Status CodeDescription
201API key created successfully.
500Error creating API key.

GET /api-keys

Responses

Status CodeDescription
200API keys retrieved successfully.
500Error fetching API keys.

GET /api-keys/{name}

Parameters

NameLocationRequiredTypeDescription
namepathtrueundefinedundefined

Responses

Status CodeDescription
200API key retrieved successfully.
404API key not found.
500Error fetching API key.

DELETE /api-keys/{name}

Parameters

NameLocationRequiredTypeDescription
namepathtrueundefinedundefined

Responses

Status CodeDescription
204API key deleted successfully.
404API key not found.
500Error deleting API key.

POST /users

Responses

Status CodeDescription
201

GET /users

Responses

Status CodeDescription
200

POST /users/{id}/regenerate-key-pair

Parameters

NameLocationRequiredTypeDescription
idpathtrueundefinedundefined

Responses

Status CodeDescription
201

GET /users/overview

Responses

Status CodeDescription
200Current usage overview

PUT /users/{id}/quota

Parameters

NameLocationRequiredTypeDescription
idpathtrueundefinedundefined

Responses

Status CodeDescription
200

GET /workspace

Parameters

NameLocationRequiredTypeDescription
verbosequeryfalseundefinedInclude verbose output

Responses

Status CodeDescription
200List of all workspaces

POST /workspace

Responses

Status CodeDescription
200The workspace has been successfully created.

GET /workspace/{workspaceId}

Parameters

NameLocationRequiredTypeDescription
workspaceIdpathtrueundefinedundefined
verbosequeryfalseundefinedInclude verbose output

Responses

Status CodeDescription
200Workspace details

DELETE /workspace/{workspaceId}

Parameters

NameLocationRequiredTypeDescription
workspaceIdpathtrueundefinedundefined
forcequerytrueundefinedundefined

Responses

Status CodeDescription
200Workspace has been deleted

POST /workspace/{workspaceId}/start

Parameters

NameLocationRequiredTypeDescription
workspaceIdpathtrueundefinedundefined

Responses

Status CodeDescription
200Workspace has been started

POST /workspace/{workspaceId}/stop

Parameters

NameLocationRequiredTypeDescription
workspaceIdpathtrueundefinedundefined

Responses

Status CodeDescription
200Workspace has been stopped

PUT /workspace/{workspaceId}/labels

Parameters

NameLocationRequiredTypeDescription
workspaceIdpathtrueundefinedundefined

Responses

Status CodeDescription
200Labels have been successfully replaced

POST /workspace/{workspaceId}/snapshot

Parameters

NameLocationRequiredTypeDescription
workspaceIdpathtrueundefinedundefined

Responses

Status CodeDescription
200Workspace snapshot has been initiated

POST /workspace/{workspaceId}/public/{isPublic}

Parameters

NameLocationRequiredTypeDescription
workspaceIdpathtrueundefinedID of the workspace
isPublicpathtrueundefinedPublic status to set

Responses

Status CodeDescription
201

POST /workspace/{workspaceId}/resize

Parameters

NameLocationRequiredTypeDescription
workspaceIdpathtrueundefinedundefined

Responses

Status CodeDescription
201

POST /workspace/{workspaceId}/autostop/{interval}

Parameters

NameLocationRequiredTypeDescription
workspaceIdpathtrueundefinedID of the workspace
intervalpathtrueundefinedAuto-stop interval in minutes (0 to disable)

Responses

Status CodeDescription
200Auto-stop interval has been set

POST /workspace/{workspaceId}/archive

Parameters

NameLocationRequiredTypeDescription
workspaceIdpathtrueundefinedundefined

Responses

Status CodeDescription
200Workspace has been archived

POST /nodes

Responses

Status CodeDescription
201

GET /nodes

Responses

Status CodeDescription
200

PATCH /nodes/{id}/scheduling

Parameters

NameLocationRequiredTypeDescription
idpathtrueundefinedundefined

Responses

Status CodeDescription
200

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

Parameters

NameLocationRequiredTypeDescription
workspaceIdpathtrueundefinedundefined

Responses

Status CodeDescription
200Project directory retrieved successfully

GET /toolbox/{workspaceId}/toolbox/files

Parameters

NameLocationRequiredTypeDescription
workspaceIdpathtrueundefinedundefined
pathqueryfalseundefinedundefined

Responses

Status CodeDescription
200Files listed successfully

DELETE /toolbox/{workspaceId}/toolbox/files

Delete file inside workspace

Parameters

NameLocationRequiredTypeDescription
workspaceIdpathtrueundefinedundefined
pathquerytrueundefinedundefined

Responses

Status CodeDescription
200File deleted successfully

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

Download file from workspace

Parameters

NameLocationRequiredTypeDescription
workspaceIdpathtrueundefinedundefined
pathquerytrueundefinedundefined

Responses

Status CodeDescription
200File downloaded successfully

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

Search for text/pattern inside workspace files

Parameters

NameLocationRequiredTypeDescription
workspaceIdpathtrueundefinedundefined
pathquerytrueundefinedundefined
patternquerytrueundefinedundefined

Responses

Status CodeDescription
200Search completed successfully

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

Create folder inside workspace

Parameters

NameLocationRequiredTypeDescription
workspaceIdpathtrueundefinedundefined
pathquerytrueundefinedundefined
modequerytrueundefinedundefined

Responses

Status CodeDescription
200Folder created successfully

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

Get file info inside workspace

Parameters

NameLocationRequiredTypeDescription
workspaceIdpathtrueundefinedundefined
pathquerytrueundefinedundefined

Responses

Status CodeDescription
200File info retrieved successfully

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

Move file inside workspace

Parameters

NameLocationRequiredTypeDescription
workspaceIdpathtrueundefinedundefined
sourcequerytrueundefinedundefined
destinationquerytrueundefinedundefined

Responses

Status CodeDescription
200File moved successfully

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

Set file owner/group/permissions inside workspace

Parameters

NameLocationRequiredTypeDescription
workspaceIdpathtrueundefinedundefined
pathquerytrueundefinedundefined
ownerqueryfalseundefinedundefined
groupqueryfalseundefinedundefined
modequeryfalseundefinedundefined

Responses

Status CodeDescription
200File permissions updated successfully

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

Replace text/pattern in multiple files inside workspace

Parameters

NameLocationRequiredTypeDescription
workspaceIdpathtrueundefinedundefined

Responses

Status CodeDescription
200Text replaced successfully

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

Search for files inside workspace

Parameters

NameLocationRequiredTypeDescription
workspaceIdpathtrueundefinedundefined
pathquerytrueundefinedundefined
patternquerytrueundefinedundefined

Responses

Status CodeDescription
200Search completed successfully

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

Upload file inside workspace

Parameters

NameLocationRequiredTypeDescription
workspaceIdpathtrueundefinedundefined
pathquerytrueundefinedundefined

Responses

Status CodeDescription
200File uploaded successfully

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

Add files to git commit

Parameters

NameLocationRequiredTypeDescription
workspaceIdpathtrueundefinedundefined

Responses

Status CodeDescription
200Files added to git successfully

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

Get branch list from git repository

Parameters

NameLocationRequiredTypeDescription
workspaceIdpathtrueundefinedundefined
pathquerytrueundefinedundefined

Responses

Status CodeDescription
200Branch list retrieved successfully

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

Create branch on git repository

Parameters

NameLocationRequiredTypeDescription
workspaceIdpathtrueundefinedundefined

Responses

Status CodeDescription
200Branch created successfully

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

Clone git repository

Parameters

NameLocationRequiredTypeDescription
workspaceIdpathtrueundefinedundefined

Responses

Status CodeDescription
200Repository cloned successfully

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

Commit changes to git repository

Parameters

NameLocationRequiredTypeDescription
workspaceIdpathtrueundefinedundefined

Responses

Status CodeDescription
200Changes committed successfully

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

Get commit history from git repository

Parameters

NameLocationRequiredTypeDescription
workspaceIdpathtrueundefinedundefined
pathquerytrueundefinedundefined

Responses

Status CodeDescription
200Commit history retrieved successfully

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

Pull changes from remote

Parameters

NameLocationRequiredTypeDescription
workspaceIdpathtrueundefinedundefined

Responses

Status CodeDescription
200Changes pulled successfully

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

Push changes to remote

Parameters

NameLocationRequiredTypeDescription
workspaceIdpathtrueundefinedundefined

Responses

Status CodeDescription
200Changes pushed successfully

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

Get status from git repository

Parameters

NameLocationRequiredTypeDescription
workspaceIdpathtrueundefinedundefined
pathquerytrueundefinedundefined

Responses

Status CodeDescription
200Git status retrieved successfully

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

Execute command synchronously inside workspace

Parameters

NameLocationRequiredTypeDescription
workspaceIdpathtrueundefinedundefined

Responses

Status CodeDescription
200Command executed successfully

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

List all active sessions in the workspace

Parameters

NameLocationRequiredTypeDescription
workspaceIdpathtrueundefinedundefined

Responses

Status CodeDescription
200Sessions retrieved successfully

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

Create a new session in the workspace

Parameters

NameLocationRequiredTypeDescription
workspaceIdpathtrueundefinedundefined

Responses

Status CodeDescription
200

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

Get session by ID

Parameters

NameLocationRequiredTypeDescription
workspaceIdpathtrueundefinedundefined
sessionIdpathtrueundefinedundefined

Responses

Status CodeDescription
200Session retrieved successfully

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

Delete a specific session

Parameters

NameLocationRequiredTypeDescription
workspaceIdpathtrueundefinedundefined
sessionIdpathtrueundefinedundefined

Responses

Status CodeDescription
200Session deleted successfully

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

Execute a command in a specific session

Parameters

NameLocationRequiredTypeDescription
workspaceIdpathtrueundefinedundefined
sessionIdpathtrueundefinedundefined

Responses

Status CodeDescription
200Command executed successfully

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

Get session command by ID

Parameters

NameLocationRequiredTypeDescription
workspaceIdpathtrueundefinedundefined
sessionIdpathtrueundefinedundefined
commandIdpathtrueundefinedundefined

Responses

Status CodeDescription
200Session command retrieved successfully

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

Get logs for a specific command in a session

Parameters

NameLocationRequiredTypeDescription
workspaceIdpathtrueundefinedundefined
sessionIdpathtrueundefinedundefined
commandIdpathtrueundefinedundefined

Responses

Status CodeDescription
200Command logs retrieved successfully

POST /toolbox/{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

NameLocationRequiredTypeDescription
workspaceIdpathtrueundefinedundefined

Responses

Status CodeDescription
200OK

POST /toolbox/{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

NameLocationRequiredTypeDescription
workspaceIdpathtrueundefinedundefined

Responses

Status CodeDescription
200OK

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

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

Parameters

NameLocationRequiredTypeDescription
workspaceIdpathtrueundefinedundefined

Responses

Status CodeDescription
200OK

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

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

Parameters

NameLocationRequiredTypeDescription
workspaceIdpathtrueundefinedundefined
languageIdquerytrueundefinedundefined
pathToProjectquerytrueundefinedundefined
uriquerytrueundefinedundefined

Responses

Status CodeDescription
200OK

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

Start Lsp server process inside workspace project

Parameters

NameLocationRequiredTypeDescription
workspaceIdpathtrueundefinedundefined

Responses

Status CodeDescription
200OK

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

Stop Lsp server process inside workspace project

Parameters

NameLocationRequiredTypeDescription
workspaceIdpathtrueundefinedundefined

Responses

Status CodeDescription
200OK

GET /toolbox/{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

NameLocationRequiredTypeDescription
workspaceIdpathtrueundefinedundefined
languageIdquerytrueundefinedundefined
pathToProjectquerytrueundefinedundefined
queryquerytrueundefinedundefined

Responses

Status CodeDescription
200OK

POST /images

Responses

Status CodeDescription
200The image has been successfully created.

GET /images

Parameters

NameLocationRequiredTypeDescription
limitqueryfalseundefinedNumber of items per page
pagequeryfalseundefinedPage number

Responses

Status CodeDescription
200List of all images with pagination

PATCH /images/{id}/toggle

Parameters

NameLocationRequiredTypeDescription
idpathtrueundefinedImage ID

Responses

Status CodeDescription
200Image state has been toggled

DELETE /images/{id}

Parameters

NameLocationRequiredTypeDescription
idpathtrueundefinedImage ID

Responses

Status CodeDescription
200Image has been deleted