Skip to main content
GET
Get Server Directory

Authorizations

Authorization
string
header
required

A Barndoor API key, sent as Authorization: Bearer <key>. Keys are prefixed bdai_ and are opaque — do not attempt to decode one. Interchangeable with an OAuth 2.0 access token.

Path Parameters

server_directory_id
string<uuid>
required

Query Parameters

include_active_server_ids
boolean
default:false

When true, include active_server_ids for this directory

Response

Successful Response

id
string<uuid>
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
runtime
Runtime · object | null
required
configuration_schema
Configuration Schema · object
required
tool_manifest
Tool Manifest · object[]
required
name
string
required
description
string | null
required
icon
string | null
required
slug
string | null
required
organization_id
string<uuid> | null
required
url
string
required
protocol
enum<string>
default:mcp
required

Protocol enum for MCP server communication.

Available options:
mcp,
sse
source
enum<string>
default:barndoor
required
Available options:
barndoor,
third_party,
internal,
custom_third_party,
custom_internal,
local,
embedded
provider
string
default:custom
required

The provider name to use when registering with OpenBao

provider_options
any
required
scopes
string[]
required
oauth_metadata
Oauth Metadata · object
required
protected_resource_metadata
Protected Resource Metadata · object
required
allow_oauth_override
boolean
default:false
required
meta
object | null
required
auth_params
any
required
credential_schema
any
required
public
boolean
default:false
required
requires_auth
boolean
default:false
required
requires_auth_observed_at
string<date-time> | null
required

When requires_auth was last observed. NULL = not observed since the last URL change.

categories
MCPServerCategory · object[]
required
active_server_ids
string[] | null
required
credential_modes
DirectoryCredentialModes · object | null
required

The OAuth credential modes a new server from this directory can use, for the calling organization. null for a directory whose provider does not use OAuth, and on the responses of the directory create and update routes.