BYOK-Schlüssel aktualisieren

Aktualisiert einen BYOK-Schlüssel: aktivieren/deaktivieren, umbenennen, Fallback-Modus wechseln, Modell-Toggles (modelToggles), Geltungsbereich neu setzen (scopedApiKeyIds). Alle Felder optional; der Upstream-Schlüssel selbst ist nicht ersetzbar — zum Rotieren löschen und neu anlegen.

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

Autorisierung

Authorizationerforderlich

string · header

API-Schlüssel als Bearer-Token im Authorization-Header.

Pfadparameter

iderforderlich

string

Die BYOK-Schlüssel-Id.

Body

enabled

boolean

Hauptschalter für den ganzen Schlüssel.

fallbackMode

string

Ob bei Upstream-Fehler auf Plattform-Routing zurückgefallen wird.

seamlessstrict

name

string

Neuer Anzeigename.

1-200 chars

modelToggles

{canonicalId, enabled}[]

Modell-Schalter: jedes Element nennt canonicalId und enabled. Nur gelistete Modelle ändern sich; der Rest bleibt.

≤2000 items

scopedApiKeyIds

string[]

Ersetzt die gesamte Scope-Liste: leeres Array stellt org-weite Geltung wieder her. Fremde Key-Ids antworten 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}]}'

Antwortbeispiele

Aktualisiert — gibt das aktualisierte { key } zurück.

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