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_api_key_hashes
string[] | null

Optional allowlist of OpenRouter API key hashes (api_keys.hash) that may use this credential. null clears the restriction. Must contain at least one hash if provided. Hashes that do not belong to your account return a 400.

Required array length: 1 - 100 elements
Pattern: ^[a-f0-9]{64}$
Example:
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

declared_region
enum<string> | null

Your declaration of the data region in which the upstream provider account behind this credential processes requests, used for routing eligibility on OpenRouter's regional hosts. null means undeclared and global is behaviorally identical: the credential follows the region OpenRouter records for the endpoint. europe or us lets requests to eu.openrouter.ai or us.openrouter.ai use this credential for that provider (private endpoints, endpoints pinned to another cloud region, cross-region inference profiles and video models are excluded). Self-declared and not verified by OpenRouter. For OpenAI and Fireworks the region comes from the key material (a {"api_key": ..., "region": ...} key), so the value must match the key's region. Among other providers, only Azure accepts europe or us. Omit to leave the stored value unchanged (rotating an OpenAI or Fireworks key re-derives it from the new key); null clears the declaration.

Available options:
global,
europe,
us,
null
Example:

null

declared_zdr
boolean | null

Your declaration of whether the upstream provider account behind this credential has zero data retention (ZDR). null inherits OpenRouter's data policy for the provider's endpoint; true declares the account ZDR so requests that require ZDR may route to this credential even when the shared endpoint retains data; false declares it non-ZDR so such requests never route to it. Self-declared and not verified by OpenRouter. Omit to leave the stored value unchanged; null clears the declaration.

Example:

null

disabled
boolean

Whether this credential is disabled.

Example:

false

is_byok_only
boolean

Whether OpenRouter's shared endpoints on this provider are removed for every model, including models outside allowed_models and after all of your keys for the provider fail. The provider is skipped instead of spending OpenRouter credits. Only valid on non-fallback credentials. Omit to leave the stored value unchanged.

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. Cannot be combined with is_byok_only. Omit to leave the stored value unchanged.

Example:

false

is_required
boolean

Whether OpenRouter's shared endpoints on this provider are removed for the models this credential applies to (its allowed_models, or every model when null). Requests for those models run only on your keys; models outside the allowlist may still fall back to shared capacity on this provider. Omit to leave the stored value unchanged.

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: