API キーを更新

キーの有効化/無効化、または支出上限の設定/解除を行います——1 回の呼び出しでどちらか一方のみ、両方は同時にできません。管理エンドポイントで、キー作成と同じ規則です:Bearer トークンは Management API Key である必要があります。ログイン済みセッションでも可。

PATCH/api/v1/keys/:id

認証

Authorization必須

string · header

Authorization ヘッダーに Bearer トークンとして API キーを渡します。

パスパラメータ

id必須

string

更新するキーの ID。

Body

enabled

boolean

このキーを有効化(true)または無効化(false)します。手動での切り替えは、支出上限による自動無効化フラグをすべてクリアするため、後で意図に反して自動再有効化されることはありません。

spendLimitUsd

number | null

支出上限(米ドル)を設定します。上限を解除するには null を渡します。enabled とは排他的です——1 回のリクエストではどちらか一方のみ送信できます。

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
}