管理

APIキーの更新

現在のWorkspace内のAPIキーを更新します。

PATCHhttps://api.tokenlab.sh/v1/management/api-keys/{keyId}

概要

既存のユーザーAPIキーの名前、使用制限額、許可モデル、有効期限、またはステータスを更新するには、このエンドポイントを使用します。

リクエストボディ

少なくとも1つのフィールドを指定する必要があります。

フィールドタイプデフォルト / 制限説明
statusenum-active、inactive、revoked
namestring長さ 1-50更新後の表示名
limitAmountnumber | string | null0–100000 USDnull は無制限を意味し、0 は支出を停止します。小数文字列は最大6桁の小数をサポートします。
limitCurrencyenumデフォルト USDUSDのみ。CNY を送信すると 400 currency_retired が返されます。設定する場合、limitAmount が必須です。
modelsstring[]-更新後のモデル許可リスト
deliveryPolicystring | nullauto、verified、official、nullnull はWorkspaceの配信ポリシーを継承します。
expiresAtstring | nullRFC3339 datetimenull は有効期限をクリアします

注意事項

  • 金額フィールドはUSDのみです。CNY の入力は廃止されており、400 currency_retired が返されます。

  • Management API には削除機能がありません。一時的な停止には inactive を、キーを完全に廃止するには revoked を使用してください。

  • 取り消されたキーは新しいキーに置き換えてください。取り消されたキーを active に設定すると 409 api_key_revoked が返されます。

  • suspended はレスポンスに表示される場合がありますが、リクエストで送信することはできません。

例

リクエスト

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

リクエスト / レスポンス

このページでは、OpenAPIスキーマとコピー可能なリクエスト例を提供しています。Management Token を使用してターミナルまたはクライアントから管理リクエストを送信してください。このページから直接送信することはできません。

レスポンス例

レスポンス

200 OK
{
  "id": "key_abc123def456",
  "name": "Backend Worker",
  "key_prefix": "sk-live...",
  "status": "inactive",
  "limit_amount": 0,
  "limit_amount_decimal": "0",
  "used_amount": 148.25,
  "used_amount_decimal": "148.25",
  "models": [
    "gpt-5.6-luna",
    "claude-sonnet-4-6"
  ],
  "expires_at": "2026-12-31T23:59:59.000Z",
  "last_used_at": "2026-07-08T03:12:45.000Z",
  "created_at": "2026-07-01T10:00:00.000Z",
  "delivery_policy": null
}

重要なフィールド

idstring
後続の Management API 呼び出しで使用されるAPIキー識別子。
namestring
APIキーの表示名。
key_prefixstring
表示およびサポート用の非シークレットなキープレフィックス。
statusstring
active、inactive、suspended、revoked のいずれか。
limit_amountnumber | null
表示用のJSON数値としてのUSD単位の使用制限額。null は無制限を意味します。
limit_amount_decimalstring | null
小数文字列としてのUSD単位の正確な使用制限額。null は無制限を意味します。
used_amountnumber
表示用のJSON数値としてのUSD単位の累積使用額。
used_amount_decimalstring
小数文字列としてのUSD単位の正確な累積使用額。
modelsstring[]
キーごとのモデル許可リスト。空の配列は、キーレベルでの追加のモデル制限がないことを意味します。
delivery_policystring | null
auto、verified、official、null。null はWorkspaceの配信ポリシーを継承します。
expires_atstring | null
キーの有効期限を示すISOタイムスタンプ。有効期限がない場合は null。
last_used_atstring | null
最新の使用日時を示すISOタイムスタンプ。未使用の場合は null。
created_atstring
ISO作成タイムスタンプ。

認証

ManagementTokenAuth
AuthorizationBearer <token>

管理トークン認証。Dashboard > API > Management Tokensで管理トークンを作成または管理します。

場所: header

パスパラメータ

keyId*string

リクエストボディ

application/json

少なくとも1つのフィールドを指定する必要があります。

プロパティ1 <= properties

レスポンス

application/json

application/json

application/json

application/json

application/json

application/json