GEgetbifrost
Providers

Update a key for a provider

Updates an existing key. Send the full key object. Redacted values sent back unchanged are automatically preserved (the server merges them with the stored raw values).

put/api/providers/{provider}/keys/{key_id}

Request

Path parameters

providerstring required

Provider name

key_idstring required

Key ID

Request body

idstring

Unique identifier for the key

namestring

Name of the key

modelsstring[]

List of models this key can access (whitelist)

blacklisted_modelsstring[]

List of models this key cannot access (blacklist)

weightnumber

Weight for load balancing

aliasesobject

Model alias mappings - maps a user-facing model name to a provider-specific identifier (deployment name, inference profile ID, fine-tuned model ID, etc.)

enabledboolean

Whether the key is active (defaults to true)

use_for_batch_apiboolean

Whether this key can be used for batch API operations

config_hashstring

Hash of config.json version, used for change detection

statusstring

Status of key (e.g., success, list_models_failed)

descriptionstring

Error or status description for the key

Response

Key updated successfully

idstring

Unique identifier for the key

namestring

Name of the key

modelsstring[]

List of models this key can access (whitelist)

blacklisted_modelsstring[]

List of models this key cannot access (blacklist)

weightnumber

Weight for load balancing

aliasesobject

Model alias mappings - maps a user-facing model name to a provider-specific identifier (deployment name, inference profile ID, fine-tuned model ID, etc.)

enabledboolean

Whether the key is active (defaults to true)

use_for_batch_apiboolean

Whether this key can be used for batch API operations

config_hashstring

Hash of config.json version, used for change detection

statusstring

Status of key (e.g., success, list_models_failed)

descriptionstring

Error or status description for the key

Changes

No recorded changes to this operation across all 1 revision of this API.