Skip to main content

Workspace Manager API

Interactive Documentation​

Base URL​

http://localhost:3001

Authentication​

Authentication is disabled by default (ENABLE_AUTH=false).

When Keycloak authentication is enabled, all API calls must include a Bearer token in the header:

Authorization: Bearer <jwt_token>

Main Endpoints​

Health Check​

GET /health

Response:

{ "status": "ok", "database": "ok", "redis": "ok" }

Workspace Management​

MethodPathDescription
GET/api/v1/workspacesList all workspaces
POST/api/v1/workspacesCreate a workspace
GET/api/v1/workspaces/{id}Get workspace details
PUT/api/v1/workspaces/{id}Update a workspace
DELETE/api/v1/workspaces/{id}Delete a workspace
POST/api/v1/workspaces/{id}/startStart a workspace
POST/api/v1/workspaces/{id}/stopStop a workspace
POST/api/v1/workspaces/{id}/restartRestart a workspace

Workspace Settings​

MethodPathDescription
GET/api/v1/workspaces/{id}/setup/*Get settings
PUT/api/v1/workspaces/{id}/setup/*Update settings

Automation Tasks​

MethodPathDescription
GET/api/v1/automationList automation tasks
POST/api/v1/automationCreate a task
GET/api/v1/automation/{id}Get a task
PUT/api/v1/automation/{id}Update a task
DELETE/api/v1/automation/{id}Delete a task
POST/api/v1/automation/{id}/triggerManually trigger

User Management​

MethodPathDescription
GET/api/v1/usersList users
POST/api/v1/usersCreate a user
GET/api/v1/users/{id}Get a user
PUT/api/v1/users/{id}Update a user

Team Management​

MethodPathDescription
GET/api/v1/teamsList teams
POST/api/v1/teamsCreate a team
POST/api/v1/teams/{id}/membersAdd a member

Other​

MethodPathDescription
GET/api/v1/settingsPlatform settings
GET/api/v1/container-imagesContainer image list
GET/api/v1/oauth/*OAuth flows

Error Format​

{
  "detail": "Error message",
  "code": "ERROR_CODE"
}

Common HTTP status codes:

StatusDescription
200Success
201Created
400Bad request
401Unauthenticated
403Forbidden
404Not found
500Server error