メインコンテンツへスキップ

​
概要

この endpoint では、既存 API Key の名前、利用上限、許可モデル、有効期限、状態を更新できます。

​
リクエストボディ

PATCH リクエストでは少なくとも 1 つのフィールドを指定する必要があります。
フィールド型既定値 / 制約説明
statusenum-active、inactive、revoked
namestring長さ 1-50更新後の表示名
limitAmountnumber | null最小 0、最大 100000null = 無制限、0 = 利用可能額 0
limitCurrencyenum既定値 USD任意: USD または CNY。CNY を指定すると limitAmount は人民元として解釈され、保存前にサーバー側で USD に換算されます
modelsstring[]-更新後の論理モデル許可リスト
expiresAtstring | nullRFC3339 datetimenull は有効期限を解除します

​
補足

  • Management API v1 ではハード削除は意図的にサポートしていません。
  • revoked は通常終端状態として扱われます。再度キーが必要な場合は、新しいキーを作成するのが一般的です。
  • デフォルトでは limitAmount は USD として解釈されます。limitCurrency: "CNY" を送ると、上限は人民元として扱われ、保存前に現在の為替レートで自動的に USD へ換算されます。
  • レスポンスには exchange_rate と、RMB 表示用の limit_amount_cny / used_amount_cny が含まれます。

​
例

curl -X PATCH "https://api.lemondata.cc/v1/management/api-keys/key_abc123def456" \
  -H "Authorization: Bearer mt-your-management-token" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "inactive",
    "limitAmount": 0
  }'

​
リクエスト / レスポンス

正確な schema とレスポンス項目は、上部のインタラクティブな OpenAPI パネルを参照してください。