跳到主要内容

接口索引

本索引覆盖当前后端注册的非资源接口。路径均相对于 /api/v1;受保护接口需要 Bearer Token 和对应 RBAC 权限。

账户与身份

方法路径说明
GET/users/me当前用户
PUT/users/me/password修改自己的密码
POST/auth/2fa/setup开始配置 TOTP
POST/auth/2fa/enable启用 TOTP
POST/auth/2fa/disable禁用 TOTP
POST/auth/public-key/register/begin开始注册通行密钥
POST/auth/public-key/register/finish完成通行密钥注册
GET/auth/public-key/credentials列出自己的凭据
PUT/auth/public-key/credentials/:id重命名凭据
DELETE/auth/public-key/credentials/:id撤销凭据

公开登录、OAuth、刷新令牌和通行密钥登录接口见认证

管理

方法路径说明
GET, POST/users用户列表或创建用户
GET, PUT, DELETE/users/:id查看、更新或删除用户
PUT/users/:id/reset-password重置密码
DELETE/users/:id/public-key-credentials/:credentialId撤销用户凭据
GET, PUT/directory/config查看或更新目录设置
POST/directory/test测试目录设置
POST/directory/preview预览组到角色映射
GET/audit-logs查询审计事件
GET/terminal-sessions终端会话列表
GET/terminal-sessions/:id会话元数据
GET/terminal-sessions/:id/play回放数据

集群与软件包

方法路径说明
GET, POST/clusters集群列表或添加集群
GET, DELETE/clusters/:id查看或移除集群
GET/clusters/:id/package-releasesHelm Release 列表
GET/clusters/:id/package-releases/:namespace/:nameRelease 详情
GET/clusters/:id/package-releases/:namespace/:name/history修订历史
POST/clusters/:id/package-releases/preview/:operationDry Run installupgrade 并签发确认令牌
POST/clusters/:id/package-releases/install安装预检中确认的同一请求
POST/clusters/:id/package-releases/upgrade升级预检中确认的同一请求
POST/clusters/:id/package-releases/:namespace/:name/check-upgrade从已记录或本次提供的索引 Helm 来源检查新的稳定 Chart 版本
POST/clusters/:id/package-releases/:namespace/:name/rollback回滚
DELETE/clusters/:id/package-releases/:namespace/:name移除 Release
GET, POST/clusters/:id/helm/repositories列出或创建托管 Helm/OCI 仓库
PUT, DELETE/clusters/:id/helm/repositories/:repositoryId更新或删除托管仓库
POST/clusters/:id/helm/repositories/:repositoryId/test测试托管仓库连接
GET/clusters/:id/helm/repositories/:repositoryId/charts浏览带索引的 Helm 仓库
GET/clusters/:id/helm/artifact-hub/search在 Artifact Hub 搜索公开 Chart
POST/clusters/:id/helm/charts/inspect检查 Chart 元数据和内容
POST/clusters/:id/helm/charts/upload上传临时打包 Chart
GET, POST/clusters/:id/helm/upgrade-policies列出或创建自动升级策略
PUT, DELETE/clusters/:id/helm/upgrade-policies/:policyId更新或删除升级策略
POST/clusters/:id/helm/upgrade-policies/:policyId/check立即执行升级策略
GET/registry-tags查询镜像标签

安装和升级请求与预检使用相同请求体,并且必须包含预检返回的一次性 confirmationToken。令牌会绑定用户、集群、命名空间、Release、Chart 来源、 Values 和操作类型。 Release 已记录来源时,检查更新请求体可以为空;旧 Release 可以提交 {"source":{"chart":"name","repoUrl":"https://..."}},验证并关联带索引的 Helm 仓库。Release 来源记录只保存 Chart 坐标,不保存仓库凭据。 仓库管理、私有凭据和升级策略需要管理员权限。Chart 上传使用 multipart/form-data,30 分钟后过期,并绑定上传用户。

AI、插件与自动化

方法路径说明
GET, PUT/ai/config查看或更新 AI 配置
POST/ai/models查询提供商模型
POST/ai/chat通过 SSE 流式返回回答
POST/ai/continue-action继续已确认的工具操作
GET/plugins插件列表
GET, PUT/plugins/:name查看或更新插件配置
GET/plugins/:name/health插件健康检查
GET/plugins/prometheus/query执行受限的即时 PromQL 查询
GET/plugins/grafana/dashboardsGrafana Dashboard 列表
GET/plugins/argocd/applicationsArgo CD 应用列表
GET, POST/webhooksWebhook 列表或创建
PUT, DELETE/webhooks/:id更新或删除 Webhook
POST/webhooks/:id/test发送测试事件

收藏夹(/favorites)和模板(/templates)也提供对应的列表、创建和删除接口。

Kubernetes HTTP 访问

GETHEAD /clusters/:id/namespaces/:namespace/http/:kind/:name/*path 会向 Pod 或 Service 转发受限且经过资源授权的请求。它不是通用 URL 代理,详见 扩展访问