管理金鑰

更新 API 金鑰

啟用/停用一把金鑰,或設定/清除它的支出上限——每次呼叫只能做其中一件事,不能兩個一起改。管理端點,規則同建立金鑰:Bearer token 必須是 Management API Key,或用登入 session。

PATCH/api/v1/keys/:id

驗證

Authorization必填

string · header

在 Authorization 標頭以 Bearer token 傳入 API 金鑰。

路徑參數

id必填

string

要更新的金鑰 ID。

Body

enabled

boolean

啟用(true)或停用(false)這把金鑰。任何一次手動切換都會清除之前因超支自動停用留下的標記,避免之後被系統誤判成自動恢復。

spendLimitUsd

number | null

設定支出上限(美元);傳 null 表示清除上限。跟 enabled 是互斥操作,同一次請求只能傳其中一種。

positive, ≤1,000,000

spendLimitPeriod

string | null

支出上限的重置週期。spendLimitUsd 有值時必填,且只接受 day/week/month 這三個原始值——不像建立金鑰那支還接受 daily/weekly/monthly 別名。

dayweekmonth

PATCH /api/v1/keys/:id

1
2
3
4
curl -X PATCH https://bazaarlink.ai/api/v1/keys/key_abc123 \
  -H "Authorization: Bearer $BAZAARLINK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"enabled": false}'

回應範例

更新成功。回應只是一個確認旗標,不含金鑰完整資料——要看最新狀態請另外呼叫列出金鑰。

1
2
3
{
  "updated": true
}