อัปเดตคีย์ BYOK

อัปเดตคีย์ BYOK หนึ่งรายการ: เปิด/ปิด เปลี่ยนชื่อ สลับโหมด fallback สวิตช์รายโมเดล (modelToggles) และตั้งขอบเขตใหม่ (scopedApiKeyIds) ทุกฟิลด์เป็นทางเลือก คีย์ upstream เองเปลี่ยนไม่ได้ — ต้องลบแล้วสร้างใหม่เพื่อหมุนคีย์

PATCH/api/v1/management/byok-keys/:id

การอนุญาต

Authorizationจำเป็น

string · header

API key เป็น bearer token ใน header Authorization

พารามิเตอร์เส้นทาง

idจำเป็น

string

id ของคีย์ BYOK

Body

enabled

boolean

สวิตช์หลักของทั้งคีย์

fallbackMode

string

จะถอยกลับไปใช้เส้นทางแพลตฟอร์มเมื่อ upstream ล้มเหลวหรือไม่

seamlessstrict

name

string

ชื่อที่แสดงใหม่

1-200 chars

modelToggles

{canonicalId, enabled}[]

สวิตช์รายโมเดล: แต่ละรายการระบุ canonicalId และ enabled เปลี่ยนเฉพาะโมเดลที่ระบุ ที่เหลือคงเดิม

≤2000 items

scopedApiKeyIds

string[]

แทนที่รายการขอบเขตทั้งชุด: อาร์เรย์ว่าง = กลับไปใช้ทั้งองค์กร ใส่ id ที่ไม่ใช่ของคุณตอบ 400

≤200 items; must be your own keys

PATCH /api/v1/management/byok-keys/:id

1
2
3
4
curl -X PATCH https://bazaarlink.ai/api/v1/management/byok-keys/byok_abc123 \
  -H "Authorization: Bearer $BAZAARLINK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"fallbackMode": "strict", "modelToggles": [{"canonicalId": "openai/gpt-4o", "enabled": false}]}'

ตัวอย่างการตอบกลับ

อัปเดตแล้ว — คืน { key } ที่อัปเดต

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
{
  "key": {
    "id": "byok_abc123",
    "ownerType": "org",
    "userId": null,
    "organizationId": "org_abc123",
    "name": "team-upstream",
    "baseUrl": "https://api.example-upstream.com/v1",
    "keyMask": "sk-abc…wxyz",
    "protocol": "openai",
    "enabled": true,
    "fallbackMode": "strict",
    "modelsStale": false,
    "lastVerifiedAt": "2026-07-29T00:00:00.000Z",
    "lastErrorAt": null,
    "lastErrorCode": null,
    "errorCount1h": 0,
    "createdAt": "2026-07-29T00:00:00.000Z",
    "updatedAt": "2026-07-29T00:00:00.000Z",
    "models": [
      {
        "canonicalId": "openai/gpt-4o",
        "upstreamModelId": "gpt-4o",
        "enabled": true
      }
    ],
    "scopedApiKeyIds": []
  }
}