APIキーを無効化

DELETE /v1/api-keys/{id}

APIキーを即座に無効化します。無効化されると、このキーを使用するすべてのリクエストは 401 UNAUTHORIZED エラーで拒否されます。

試してみる

このエンドポイントを Swagger UI でインタラクティブにテストできます。

認証が必要です

Authorization ヘッダーにAPIキーを含めてください。

DANGER

キーの無効化は即時かつ永続的です。このキーを使用しているシステムは即座にアクセスを失います。この操作は取り消すことができません -- 新しいキーを作成してシステムを更新する必要があります。

リクエスト

ヘッダー

ヘッダー	値	必須
`Authorization`	`Bearer <token>`	はい

パスパラメータ

パラメータ	型	必須	説明
`id`	`string`	はい	無効化するAPIキーのID（例：`ak_1a2b3c4d5e6f7g8h`）。

コード例

curlTypeScriptPython

bash

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

例

json

{
  "success": true
}

エラー

ステータス	コード	説明
`401`	`UNAUTHORIZED`	APIキー/トークンが欠落、無効、または期限切れです。
`403`	`FORBIDDEN`	このAPIキーは別のユーザーに属しています。自分のキーのみ無効化できます。
`404`	`NOT_FOUND`	指定されたIDのAPIキーが見つかりません。

APIキーを無効化 ​

リクエスト ​

ヘッダー ​

パスパラメータ ​

コード例 ​

レスポンス ​

例 ​

エラー ​