Skip to main content
PUT
/
admin
/
connections
/
{id}
Update a credential
curl --request PUT \
  --url https://{organization_id}.platform.barndoor.ai/api/llm-gateway/admin/connections/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "base_url": "<string>",
  "auth_type": "api_key",
  "api_key": "<string>",
  "credentials": {},
  "settings": {}
}
'
{
  "id": "4f8b2a3c-12ee-4d92-9c7b-e7d2f8b0a111",
  "org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "OpenAI Production",
  "model_provider": "openai",
  "auth_type": "api_key",
  "base_url": "https://api.openai.com/v1",
  "settings": {
    "region": "us-east-1",
    "model_api_family": "anthropic_messages"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

JWT obtained through Barndoor's authentication flow. Pass the token verbatim in Authorization: Bearer <token>. Use the Barndoor SDK's loginInteractive() helper to obtain a token in scripts and notebooks.

Path Parameters

​
id
string<uuid>
required

Credential UUID

Body

application/json

All fields are optional. Omit a field to leave the existing value unchanged. Sending api_key or credentials rotates the stored secret in the encrypted secret store.

​
name
string
​
base_url
string<uri>
​
auth_type
string

The authentication scheme this credential or provider uses to talk to the upstream model provider. Valid values depend on model_provider: for OpenAI/Anthropic-style vendors this is typically api_key; for AWS Bedrock it is one of aws_role, aws_keys, or bedrock_api_key; for Google Vertex it is google_adc, google_service_account, or google_impersonation; Anthropic OAuth passthrough uses oauth_passthrough.

Example:

"api_key"

​
api_key
string<password>
​
credentials
object
​
settings
object

Response

The updated credential

A reusable upstream credential, called Credentials in the portal UI. One credential can back multiple providers (e.g. a single OpenAI key used by several routes).

​
id
string<uuid>
required
Example:

"4f8b2a3c-12ee-4d92-9c7b-e7d2f8b0a111"

​
org_id
string<uuid>
required

The organization that owns this credential

​
name
string
required
Example:

"OpenAI Production"

​
model_provider
enum<string>
required

Slug of the upstream model provider this resource speaks to

Available options:
openai,
anthropic,
azure_openai,
google_ai,
bedrock,
vertex,
groq,
together,
mistral,
cohere,
xai,
fireworks,
perplexity,
openrouter,
deepseek,
custom
Example:

"openai"

​
auth_type
string
required

The authentication scheme this credential or provider uses to talk to the upstream model provider. Valid values depend on model_provider: for OpenAI/Anthropic-style vendors this is typically api_key; for AWS Bedrock it is one of aws_role, aws_keys, or bedrock_api_key; for Google Vertex it is google_adc, google_service_account, or google_impersonation; Anthropic OAuth passthrough uses oauth_passthrough.

Example:

"api_key"

​
base_url
string<uri>
required

Upstream base URL the credential points at. Defaults to the public provider URL but can be overridden for self-hosted or proxy setups.

Example:

"https://api.openai.com/v1"

​
settings
object
required

Provider-specific settings that aren't sensitive (e.g. AWS region, Vertex project id, Azure API version). Sensitive credentials live in the encrypted secret store and are never returned by the API.

Example:
{
  "region": "us-east-1",
  "model_api_family": "anthropic_messages"
}
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required