跳到主要內容
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
授權
需要帳戶管理員等級的 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'