Perbarui BYOK key

Memperbarui satu BYOK key: aktif/nonaktif, ganti nama, ubah mode fallback, toggle per model (modelToggles), dan atur ulang cakupan (scopedApiKeyIds). Semua field opsional; upstream key sendiri tidak bisa diganti — hapus dan buat ulang untuk merotasinya.

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

Otorisasi

Authorizationwajib

string · header

API key sebagai bearer token di header Authorization.

Parameter path

idwajib

string

Id BYOK key.

Body

enabled

boolean

Saklar utama seluruh kunci.

fallbackMode

string

Apakah kembali ke routing platform saat upstream gagal.

seamlessstrict

name

string

Nama tampilan baru.

1-200 chars

modelToggles

{canonicalId, enabled}[]

Saklar per model: tiap elemen memuat canonicalId dan enabled. Hanya model yang tercantum berubah; sisanya tetap.

≤2000 items

scopedApiKeyIds

string[]

Mengganti seluruh daftar cakupan: array kosong = kembali berlaku seluruh organisasi. Id yang bukan milik Anda menjawab 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}]}'

Contoh respons

Diperbarui — mengembalikan { key } terbaru.

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": []
  }
}