Skip to main content
PATCH
Update a BYOK provider credential

Authorizations

Authorization
string
header
required

API key as bearer token in Authorization header

Path Parameters

id
string<uuid>
required

The BYOK credential ID (UUID).

Example:

"11111111-2222-3333-4444-555555555555"

Body

application/json
allowed_models
string[] | null

Optional allowlist of model slugs this credential may be used for. null means no restriction.

Maximum array length: 100
Example:

null

allowed_user_ids
string[] | null

Optional allowlist of user IDs that may use this credential. null means no restriction.

Maximum array length: 100
Example:

null

disabled
boolean

Whether this credential is disabled.

Example:

false

is_fallback
boolean

Whether this credential is treated as a fallback — used only after non-fallback keys for the same provider have been tried.

Example:

false

key
string

A new raw provider API key to rotate the credential in-place. The previous key material is overwritten and the masked label is regenerated. Encrypted at rest and never returned in API responses.

Minimum string length: 1
Example:

"sk-proj-newkey456..."

name
string | null

Optional human-readable name for the credential.

Maximum string length: 255
Example:

"Updated OpenAI Key"

Response

BYOK credential updated successfully

data
object
required

The updated BYOK credential.

Example: