TokenLab
API キーを取得
ドキュメントAPIリファレンス連携

管理

API Key を更新

現在の組織にある既存ユーザー API Key を更新します。

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

概要

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

リクエストボディ

PATCH リクエストでは少なくとも 1 つのフィールドを指定する必要があります。

フィールド型既定値 / 制約説明
statusenum-active, inactive, revoked
namestring長さ 1-50更新後の表示名
limitAmountnumber | string | null0–100000 USDnull は無制限、0 は支出不可です。10 進文字列は小数点以下 6 桁まで指定できます。
limitCurrencyenum既定 USDUSD のみです。CNY を送信すると 400 currency_retired が返されます。 指定する場合は limitAmount も必要です。
modelsstring[]-更新後のモデル許可リスト
deliveryPolicystring | nullauto, verified, official, nullnull はワークスペースの配信ポリシーを継承します。
expiresAtstring | nullRFC3339 datetimenull は有効期限を解除します

補足

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

  • Management API v1 ではハード削除は意図的にサポートしていません。

  • revoked は通常終端状態として扱われます。再度キーが必要な場合は、新しいキーを作成するのが一般的です。

例

リクエスト

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-3-7-sonnet"
  ],
  "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
10 進文字列で返される USD の正確な利用上限。null は無制限を意味します。
used_amountnumber
表示用に JSON 数値で返される USD の累積利用額。
used_amount_decimalstring
10 進文字列で返される USD の正確な累積利用額。
modelsstring[]
キー単位のモデル許可リスト。空の配列は、キー単位の追加モデル制限がないことを意味します。
delivery_policystring | null
auto, verified, official, null. null はワークスペースの配信ポリシーを継承します。
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

API Key を作成

前へ

API Key の使用量を取得

次へ