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

レスポンスボディには、APIキーメタデータオブジェクトの data 配列が含まれています。

フィールド

配列内の各オブジェクトには以下が含まれます：

フィールド	型	説明
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キー/トークンが欠落、無効、または期限切れです。