Skip to main content
GET
Get a provider

Authorizations

Authorization
string
header
required

An access token from Barndoor's identity provider, sent as Authorization: Bearer <token>. Use a service-account token from the OAuth 2.0 client-credentials grant for scripts and CI, or a signed-in user's token. The caller needs the admin role in the organization. Gateway API keys (bd-...) are not accepted here.

Path Parameters

id
string<uuid>
required

Record ID (UUID)

Response

OK

An upstream provider.

auth_type
string
required
base_url
string
required
billing_mode
enum<string>
required

Whether the gateway records a per-token cost for this provider's traffic.

Available options:
per_token,
not_metered
created_at
string<date-time>
required
enabled
boolean
required

Whether the provider may serve traffic.

enforce_health_check
boolean
required

Whether routing waits on the connectivity check. When false the provider serves even while its check fails; health is still recorded.

health_status
string
required

Upstream reachability from the connectivity check: unverified, healthy, or unhealthy. Separate from enabled. An enabled provider that turns unhealthy stops receiving traffic until a check records it healthy again, unless enforce_health_check is false. Some provider families are not checked and stay unverified.

id
string<uuid>
required
model_provider
string
required
model_sync_mode
enum<string>
required

Whether this provider follows Barndoor's model catalog.

Available options:
off,
additive,
full
name
string
required
org_id
string<uuid>
required
secret_path
string
required

Internal reference to the stored secret. This is not the secret.

settings
any
required
updated_at
string<date-time>
required
created_by_email
string | null
created_by_name
string | null
created_by_user_id
string<uuid> | null
last_change_note
string | null

Note explaining the last change.

last_modified_at
string<date-time> | null

When the last attributed change was made.

last_modified_by_email
string | null
last_modified_by_name
string | null
last_modified_by_user_id
string<uuid> | null
billing_note
string | null

Note about the billing arrangement.

billing_reason
null | enum<string>

How the vendor bills this provider. Descriptive only.

Available options:
subscription,
local,
external,
other
catalog_id
string<uuid> | null
catalog_slug
string | null
connection_id
string<uuid> | null

ID of the credential this provider uses.

health_checked_at
string<date-time> | null

When the last connectivity check ran; null before the first check.

health_detail
string | null

Reason for the last unhealthy result; null otherwise.

request_timeout_secs
integer<int32> | null

Provider-wide fallback for the non-streaming request timeout, in seconds.

stream_idle_timeout_secs
integer<int32> | null

Provider-wide fallback for the streaming idle timeout, in seconds.