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 키를 찾을 수 없습니다.