跳至主要内容

Workspace Manager API

互動式文件​

Base URL​

http://localhost:3001

認證​

預設無需認證（ENABLE_AUTH=false）。

啟用 Keycloak 認證後，所有 API 需要在 Header 帶入 Bearer Token：

Authorization: Bearer <jwt_token>

主要端點​

健康檢查​

GET /health

回應：

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

工作區管理​

Method路徑說明
GET/api/v1/workspaces列出所有 workspace
POST/api/v1/workspaces建立 workspace
GET/api/v1/workspaces/{id}取得 workspace 詳情
PUT/api/v1/workspaces/{id}更新 workspace
DELETE/api/v1/workspaces/{id}刪除 workspace
POST/api/v1/workspaces/{id}/start啟動 workspace
POST/api/v1/workspaces/{id}/stop停止 workspace
POST/api/v1/workspaces/{id}/restart重啟 workspace

工作區設定​

Method路徑說明
GET/api/v1/workspaces/{id}/setup/*取得設定
PUT/api/v1/workspaces/{id}/setup/*更新設定

自動化任務​

Method路徑說明
GET/api/v1/automation列出自動化任務
POST/api/v1/automation建立任務
GET/api/v1/automation/{id}取得任務
PUT/api/v1/automation/{id}更新任務
DELETE/api/v1/automation/{id}刪除任務
POST/api/v1/automation/{id}/trigger手動觸發

使用者管理​

Method路徑說明
GET/api/v1/users列出使用者
POST/api/v1/users建立使用者
GET/api/v1/users/{id}取得使用者
PUT/api/v1/users/{id}更新使用者

團隊管理​

Method路徑說明
GET/api/v1/teams列出團隊
POST/api/v1/teams建立團隊
POST/api/v1/teams/{id}/members新增成員

其他​

Method路徑說明
GET/api/v1/settings平台設定
GET/api/v1/container-images容器映像列表
GET/api/v1/oauth/*OAuth 流程

錯誤格式​

{
  "detail": "錯誤訊息",
  "code": "ERROR_CODE"
}

常見 HTTP 狀態碼：

狀態碼說明
200成功
201建立成功
400請求格式錯誤
401未認證
403無權限
404資源不存在
500伺服器錯誤