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 키 / 토큰.