Skip to content

删除 API Key

POST/web/v1/workspaces/{workspaceId}/api-keys/deleteJWT

永久删除(软删除)一个 API Key。已删除的密钥无法恢复或重新启用。

鉴权

Auth Chain: WEB Chain — 需要 Authorization: Bearer <jwt> 需要工作空间 OWNER 角色。 以下请求头由系统自动注入(前端无需处理): X-PORTAL-ACCESS-CODE (Nginx)、X-Request-Id (Gateway)

请求参数

NameTypeRequiredInDescription
workspaceIdstringYespath工作空间业务 ID
keyIdstringYesbody要删除的 API Key 业务 ID

成功响应

无内容204
"{null}"

错误响应

未授权401
{
  "success": false,
  "code": "4010",
  "message": "Invalid or expired token"
}
禁止访问 — 非工作空间所有者403
{
  "success": false,
  "code": "4030",
  "message": "Only workspace owner can manage API keys"
}

说明

  • 此操作为软删除;密钥记录会被标记为已删除,但不会从物理层面移除。
  • 已删除的密钥无法再用于 API 请求鉴权,且无法重新启用。
  • 仅工作空间 OWNER 可删除 API Key。

内部文档