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

​
概要

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

​
リクエストボディ

PATCH リクエストでは少なくとも 1 つのフィールドを指定する必要があります。
フィールド型既定値 / 制約説明
statusenum-active, inactive, revoked
namestring長さ 1-50更新後の表示名
limitAmountnumber | null最小 0、入力上限 1000000null = 無制限、0 = 利用可能額 0、正の値は保存時に正規化され、100000 USD 相当を超えません
limitCurrencyenum既定 USDUSD のみです。CNY を送信すると 400 currency_retired が返されます。
modelsstring[]-更新後のモデル許可リスト
expiresAtstring | nullRFC3339 datetimenull は有効期限を解除します

​
補足

  • Management API v1 ではハード削除は意図的にサポートしていません。
  • revoked は通常終端状態として扱われます。再度キーが必要な場合は、新しいキーを作成するのが一般的です。

​
例

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
  }'

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

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

​
Response example

{
  "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-mini",
    "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"
}

​
Important fields

​
id
string
API key identifier used in follow-up Management API calls.
​
name
string
Display name for the API key.
​
key_prefix
string
Non-secret key prefix for display and support.
​
status
string
One of active, inactive, or revoked.
​
limit_amount
number | null
Spending cap in USD as a JSON number for display. null means unlimited.
​
limit_amount_decimal
string | null
Exact spending cap in USD as a decimal string. null means unlimited.
​
used_amount
number
Accumulated usage in USD as a JSON number for display.
​
used_amount_decimal
string
Exact accumulated usage in USD as a decimal string.
​
models
string[]
Per-key model allowlist. Empty array means no additional key-level model restriction.
​
expires_at
string | null
ISO timestamp when the key expires, or null for no expiry.
​
last_used_at
string | null
ISO timestamp for the most recent use, or null when unused.
​
created_at
string
ISO creation timestamp.