跳转到主要内容
PATCH
更新 API 密钥
此端点需要管理 API 密钥。不接受标准网关 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日