列出 API 密钥

GET /v1/api-keys

列出已认证用户所有有效（未吊销）的 API 密钥。响应中不会包含原始密钥值或哈希值 -- 仅包含用于识别和管理的元数据。

试一试

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

需要认证

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

请求

请求头

头	值	必需
Authorization	Bearer <token>	是

此端点不接受查询参数或请求体。

代码示例

curl

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

TypeScript

const apiKey = process.env.DOCMAP_API_KEY

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

const { data } = await response.json()

for (const key of data) {
  console.log(`${key.name} (${key.prefix}...) — created ${key.createdAt}`)
}

Python

import requests

api_key = "dm_live_abc123def456ghi789jkl012mno345"

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

keys = response.json()["data"]

for key in keys:
    print(f"{key['name']} ({key['prefix']}...) — created {key['createdAt']}")

响应

状态码：200 OK

响应体包含一个 data 数组，由 API 密钥元数据对象组成。

字段

数组中每个对象包含：

字段	类型	描述
id	string	API 密钥的唯一标识符。
userId	string	拥有该密钥的用户 ID。
name	string	密钥的描述性标签。
prefix	string	密钥的前几个字符，用于识别（例如 dm_live_abc1）。
expiresAt	string | null	ISO 8601 过期时间戳，如果密钥永不过期则为 null。
lastUsedAt	string | null	密钥最后使用时间的 ISO 8601 时间戳。如果从未使用则为 null。
createdAt	string	密钥创建时间的 ISO 8601 时间戳。
revoked	boolean	密钥是否已被吊销。此响应中始终为 false，因为只返回有效密钥。

示例

{
  "data": [
    {
      "id": "ak_1a2b3c4d5e6f7g8h",
      "userId": "uid_a1b2c3d4e5f6",
      "name": "Production Server",
      "prefix": "dm_live_r4nd",
      "expiresAt": "2025-02-18T10:00:00.000Z",
      "lastUsedAt": "2024-11-20T16:45:00.000Z",
      "createdAt": "2024-11-20T10:00:00.000Z",
      "revoked": false
    },
    {
      "id": "ak_9i8h7g6f5e4d3c2b",
      "userId": "uid_a1b2c3d4e5f6",
      "name": "Local Development",
      "prefix": "dm_live_t3st",
      "expiresAt": null,
      "lastUsedAt": "2024-11-19T08:30:00.000Z",
      "createdAt": "2024-10-05T12:00:00.000Z",
      "revoked": false
    }
  ]
}

错误

状态码	错误码	描述
401	UNAUTHORIZED	缺少、无效或已过期的 API 密钥/令牌。