コンテンツへスキップ
APIリファレンス
APIリファレンス

APIキーの削除

過去の使用記録を削除せずにStandard APIキーを失効させます。

Markdownを表示

過去の使用記録を削除せずにStandard APIキーを失効させます。

エンドポイント

DELETE /api/v1/keys/:id
ベースURL
https://runapi.ai
API バージョン
v1
認証
Authorization: Bearer YOUR_MANAGEMENT_API_KEY
Authorization
アカウント管理者の Management API キーが必要で、そのユーザーが所有するキーのみ操作できます。
02

リクエスト

JSONボディ

指定されたリクエストの場所にのみ値を送信してください。

パスパラメータフィールド1件
idstring
必須

API キーのプレフィックス ID（例：token_123）。

03

成功レスポンス

HTTP 204

DELETE /api/v1/keys/:id

このレスポンスにはボディがありません。

04

エラーレスポンス (401)

HTTP 401
レスポンススキーマ
JSON 
{
  "properties": {
    "error": {
      "description": "人が読めるエラーメッセージ。",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

レスポンス例

JSON 
{
  "error": "Authentication required"
}
05

エラーレスポンス (403)

HTTP 403
レスポンススキーマ
JSON 
{
  "properties": {
    "error": {
      "description": "人が読めるエラーメッセージ。",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

レスポンス例

JSON 
{
  "error": "Management API key required"
}
06

エラーレスポンス (403)

HTTP 403
レスポンススキーマ
JSON 
{
  "properties": {
    "error": {
      "description": "人が読めるエラーメッセージ。",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

レスポンス例

JSON 
{
  "error": "Account admin required"
}
07

エラーレスポンス (404)

HTTP 404
レスポンススキーマ
JSON 
{
  "properties": {
    "error": {
      "description": "人が読めるエラーメッセージ。",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

レスポンス例

JSON 
{
  "error": "Resource not found"
}
08

cURLの例

CURL 
curl -X DELETE https://runapi.ai/api/v1/keys/token_123 \
  -H 'Authorization: Bearer YOUR_MANAGEMENT_API_KEY'