الإدارة

تحديث API Key

تحديث API key في مساحة العمل (Workspace) الحالية.

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

نظرة عامة

استخدم نقطة النهاية (endpoint) هذه لتحديث الاسم، أو حد الاستخدام، أو النماذج المسموح بها، أو تاريخ انتهاء الصلاحية، أو حالة API key حالي خاص بالمستخدم.

نص الطلب (Request Body)

يجب توفير حقل واحد على الأقل.

الحقلالنوعالافتراضي / الحدودملاحظات
statusenum-active، inactive، revoked
namestringالطول 1-50اسم العرض المحدّث
limitAmountnumber | string | null0–100000 USDالقيمة null تعني غير محدود؛ القيمة 0 تمنع الإنفاق. تدعم السلاسل العشرية (decimal strings) ما يصل إلى 6 منازل عشرية.
limitCurrencyenumالافتراضي USDبالـ USD فقط. إرسال CNY يرجع الخطأ 400 currency_retired. عند تعيينه، يكون limitAmount مطلوباً.
modelsstring[]-القائمة البيضاء المحدّثة للنماذج
deliveryPolicystring | nullauto، verified، official، nullالقيمة null ترث سياسة التسليم الخاصة بـ Workspace.
expiresAtstring | nullتاريخ ووقت بتنسيق RFC3339القيمة null تلغي تاريخ انتهاء الصلاحية

ملاحظات

  • الحقول المالية تدعم عملة USD فقط. تم إيقاف مدخلات CNY وترجع الخطأ 400 currency_retired.

  • لا يوفر Management API إمكانية الحذف. استخدم inactive للإيقاف المؤقت وrevoked لتعطيل المفتاح نهائياً.

  • استبدل المفتاح الملغى (revoked) بمفتاح جديد. ضبط مفتاح ملغى إلى active يرجع الخطأ 409 api_key_revoked.

  • يمكن أن تظهر الحالة suspended في الاستجابات، ولكن لا يمكنك إرسالها.

مثال

الطلب

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 وأمثلة طلبات قابلة للنسخ. أرسل طلبات الإدارة من الطرفية (terminal) أو العميل الخاص بك باستخدام 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-sonnet-4-6"
  ],
  "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
معرّف API key المستخدم في استدعاءات Management API اللاحقة.
namestring
اسم العرض لـ API key.
key_prefixstring
بادئة المفتاح غير السرية لأغراض العرض والدعم الفني.
statusstring
واحدة من الحالات التالية: active، inactive، suspended، أو revoked.
limit_amountnumber | null
الحد الأقصى للإنفاق بالـ USD كرقم JSON للعرض. القيمة null تعني غير محدود.
limit_amount_decimalstring | null
الحد الأقصى الدقيق للإنفاق بالـ USD كسلسلة عشرية (decimal string). القيمة null تعني غير محدود.
used_amountnumber
الاستخدام التراكمي بالـ USD كرقم JSON للعرض.
used_amount_decimalstring
الاستخدام التراكمي الدقيق بالـ USD كسلسلة عشرية (decimal string).
modelsstring[]
القائمة البيضاء للنماذج المسموح بها لكل مفتاح. المصفوفة الفارغة تعني عدم وجود قيود إضافية على مستوى المفتاح.
delivery_policystring | null
auto، verified، official، null. القيمة null ترث سياسة التسليم الخاصة بـ Workspace.
expires_atstring | null
طابع زمني بتنسيق ISO لوقت انتهاء صلاحية المفتاح، أو null في حال عدم وجود تاريخ انتهاء.
last_used_atstring | null
طابع زمني بتنسيق ISO لآخر استخدام، أو null إذا لم يُستخدم بعد.
created_atstring
طابع زمني بتنسيق ISO لوقت الإنشاء.

التفويض

ManagementTokenAuth
AuthorizationBearer <token>

مصادقة رمز الإدارة (Management token). قم بإنشاء أو إدارة رموز الإدارة في Dashboard > API > Management Tokens.

الموضع: header

معاملات المسار

keyId*string

جسم الطلب

application/json

يجب توفير حقل واحد على الأقل.

الخصائص1 <= properties

الاستجابة

application/json

application/json

application/json

application/json

application/json

application/json