吊销 API 密钥

DELETE /v1/api-keys/{id}

立即吊销 API 密钥。一旦吊销，使用该密钥的任何请求都将被拒绝并返回 401 UNAUTHORIZED 错误。

试一试

在 Swagger UI 中交互式测试此端点。

需要认证

在 Authorization 头中包含您的 API 密钥。

DANGER

吊销密钥是即时且永久的操作。任何使用该密钥的系统将立即失去访问权限。此操作不可撤销 -- 您需要创建新密钥并更新您的系统。

请求

请求头

头	值	必需
Authorization	Bearer <token>	是

路径参数

参数	类型	必需	描述
id	string	是	要吊销的 API 密钥 ID（例如 ak_1a2b3c4d5e6f7g8h）。

代码示例

curl

curl -X DELETE https://api.docmap.io/v1/api-keys/ak_1a2b3c4d5e6f7g8h \
  -H "Authorization: Bearer dm_live_abc123def456ghi789jkl012mno345"

TypeScript

const apiKey = process.env.DOCMAP_API_KEY
const keyId = 'ak_1a2b3c4d5e6f7g8h'

const response = await fetch(
  `https://api.docmap.io/v1/api-keys/${keyId}`,
  {
    method: 'DELETE',
    headers: { 'Authorization': `Bearer ${apiKey}` },
  },
)

const result = await response.json()
console.log(result) // { success: true }

Python

import requests

api_key = "dm_live_abc123def456ghi789jkl012mno345"
key_id = "ak_1a2b3c4d5e6f7g8h"

response = requests.delete(
    f"https://api.docmap.io/v1/api-keys/{key_id}",
    headers={"Authorization": f"Bearer {api_key}"},
)

print(response.json())  # {"success": True}

响应

状态码：200 OK

示例

{
  "success": true
}

错误

状态码	错误码	描述
401	UNAUTHORIZED	缺少、无效或已过期的 API 密钥/令牌。
403	FORBIDDEN	该 API 密钥属于其他用户。您只能吊销自己的密钥。
404	NOT_FOUND	指定 ID 的 API 密钥未找到。