الانتقال إلى المحتوى الرئيسي
PATCH
تحديث مفتاح API
تتطلب نقطة النهاية هذه مفتاح API للإدارة. لا تُقبل مفاتيح Gateway القياسية.
استخدم هذا المسار لإعادة تسمية المفتاح أو ضبط النطاقات أو تحديد انتهاء الصلاحية أو تعطيله أو وضع حد للإنفاق باستخدام 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

حد إنفاق اختياري لهذا المفتاح بالدولار الأمريكي. اضبطه على 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

المكان الذي تحتفظ فيه بهذا المفتاح، مثل منصة الاستضافة التي تحتفظ به في متغيرات البيئة. اختياري. إذا أبلغ أحد هذه الأماكن عن اختراق، يمكنك العثور على كل المفاتيح المخزنة فيه وإبطالها. المعرّفات المعروفة: 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
مطلوب
آخر تعديل في ١٦ نوفمبر ٢٠٢٦