メインコンテンツへスキップ
PATCH
API キーを更新
このエンドポイントには管理APIキーが必要です。通常のGateway APIキーは使用できません。
キー名の変更、スコープの調整、有効期限の設定、無効化、または limit と limit_reset による支出上限の設定に使います。

承認

Authorization
string
header
必須

Bearer トークンによる認証

パスパラメータ

id
string
必須

API キーの識別子またはハッシュです。

ボディ

application/json
name
string
Minimum string length: 1
scopes
例:

"[\"chat.completions\",\"responses\"]"

limit
number | null

このキーの任意の支出上限(USD)です。解除するには null に設定します。

必須範囲: x >= 0
limit_reset
enum<string>

支出上限の期間に使用する期間です。

利用可能なオプション:
daily,
weekly,
monthly
include_byok_in_limit
boolean

互換性のために受け付けます。現在の Phaseo の動作では、BYOK は常にこの上限の対象外です。

expires_at
string<date-time> | null
disabled
boolean
soft_blocked
boolean
limits
object
department_id
string<uuid> | null

部門のレート制限と予算の対象として、このキーが属する部門。Null の場合、キーはワークスペース全体の制限にのみ計上されます。

storage_locations
string[] | null

このキーの保管場所(キーを環境変数に保持しているホスティングプラットフォームなど)。任意です。保管場所で情報漏えいが報告された場合、そこに保管されているすべてのキーを見つけて無効化できます。既知の ID: railway, vercel, netlify, render, fly, heroku, cloudflare, supabase, firebase, digitalocean, replit, modal, convex, koyeb, coolify, northflank, expo, deno-deploy, aws, google-cloud, azure, hetzner, vultr, linode, ovhcloud, scaleway, kubernetes, github, gitlab, circleci, bitbucket, 1password, bitwarden, hashicorp-vault, doppler, infisical, local-machine, own-server, other。

Maximum array length: 8
Pattern: ^[a-z0-9][a-z0-9-]{0,39}$
例:
ip_allowlist
object[]

キーを使用できるアドレス。各エントリはラベル付きの IPv4 または IPv6 アドレス、もしくは CIDR 範囲です。空の場合はすべてのアドレスが許可されます。

Maximum array length: 100

レスポンス

API キーのメタデータを更新しました

data
object
必須
最終更新日 2026年11月16日