تدوير مفتاح واجهة برمجية
تدوير مفتاح واجهة برمجية
POST
/v1/projects/{projectId}/keys/{keyId}/rotateتدعم هذه العملية مصادقة ملف ارتباط جلسة لوحة التحكم. استدعها من شيفرة خادم موثوقة فقط، ولا تنشئ المتصفحات ملف الجلسة أو تكشفه.
ينشئ مفتاحًا بديلًا بالاسم والصلاحيات نفسيهما ويلغي القديم داخل المعاملة نفسها. تُعرض قيمة keyRaw البديلة مرة واحدة فقط.
رموز الخطأ: unauthorized (401), invalid_body (400),
not_found (404), already_revoked (409),
idempotency_key_conflict (409), rotation_secret_expired (409),
rotation_secret_unrecoverable (409), key_generation_failed (500).
المصادقة
- sessionCookie — ملف ارتباط جلسة لوحة التحكم الذي يضبطه
POST /v1/auth/login. تتطلب مسارات الفيديو والتشغيل أيضًا معاملprojectIdعند استخدام الجلسة.
المعاملات
| الاسم | الموضع | النوع | إلزامي | الوصف |
|---|---|---|---|---|
projectId | path | string (Ulid) | نعم | — |
keyId | path | string (Ulid) | نعم | — |
جسم الطلب
اختياري
نوع المحتوى: application/json
المخطّط: ApiKeyRotateRequest
{
"idempotencyKey": "rotate-billing-key-2026-07-26T09:15:00Z"
}الاستجابات
| الرمز | المعنى |
|---|---|
201 | المفتاح البديل. خزّن keyRaw الآن لأنه لن يُعرض مرة أخرى، ولا يمكن استرجاعه إلا بإعادة الطلب بنفس idempotencyKey خلال 10 دقائق فقط. |
400 | فشل التحقق من جسم الطلب أو معاملاته. يذكر وصف العملية قيم error.code الدقيقة. |
401 | لم تُقدَّم بيانات اعتماد صالحة. |
404 | المورد غير موجود أو غير مرئي لهذا المستدعي. |
409 | يتعارض الطلب مع الحالة الحالية للمورد. يذكر وصف العملية قيم error.code الدقيقة. |
429 | تم تجاوز حد المعدّل. |
500 | تعذّر على الخادم إكمال الطلب. |
مثال على الطلب
{
"idempotencyKey": "rotate-billing-key-2026-07-26T09:15:00Z"
}