latestOpenAPI 3.1.02026-08-197104501.1 MB
8fbaab4fc7c5
mcp
Register Mcp Server
Submit a new MCP server for admin review (non-admin users). Mirrors POST /guardrails/register.
post/v1/mcp/server/register
Request body
server_idstring nullable
server_namestring nullable
aliasstring nullable
descriptionstring nullable
transport'sse' | 'http' | 'stdio'
auth_type'none' | 'api_key' | 'bearer_token' | 'basic' | 'authorization' | 'oauth2' | 'aws_sigv4' | 'token' nullable
urlstring nullable
spec_pathstring nullable
mcp_infoobject nullable
mcp_access_groupsstring[]
allowed_toolsstring[] nullable
tool_name_to_display_nameobject nullable
tool_name_to_descriptionobject nullable
extra_headersstring[] nullable
static_headersobject nullable
instructionsstring nullable
commandstring nullable
argsstring[]
envobject
authorization_urlstring nullable
token_urlstring nullable
registration_urlstring nullable
oauth2_flow'client_credentials' | 'authorization_code' nullable
allow_all_keysboolean
available_on_public_internetboolean
is_byokboolean
byok_descriptionstring[]
byok_api_key_help_urlstring nullable
source_urlstring nullable
approval_statusstring nullable
Server-managed: set by the endpoint; caller values are overridden.
submitted_bystring nullable
Server-managed: set by the endpoint; caller values are overridden.
submitted_atstring date-time nullable
Server-managed: set by the endpoint; caller values are overridden.
Response
Successful Response
server_idstring required
server_namestring nullable
aliasstring nullable
descriptionstring nullable
urlstring nullable
spec_pathstring nullable
transport'sse' | 'http' | 'stdio' required
auth_type'none' | 'api_key' | 'bearer_token' | 'basic' | 'authorization' | 'oauth2' | 'aws_sigv4' | 'token' nullable
instructionsstring nullable
created_atstring date-time nullable
created_bystring nullable
updated_atstring date-time nullable
updated_bystring nullable
teamsobject[]
mcp_access_groupsstring[]
allowed_toolsstring[]
tool_name_to_display_nameobject nullable
tool_name_to_descriptionobject nullable
extra_headersstring[]
mcp_infoobject nullable
static_headersobject nullable
status'healthy' | 'unhealthy' | 'unknown' nullable
Health status: 'healthy', 'unhealthy', 'unknown'
last_health_checkstring date-time nullable
health_check_errorstring nullable
commandstring nullable
argsstring[]
envobject
authorization_urlstring nullable
token_urlstring nullable
registration_urlstring nullable
allow_all_keysboolean
available_on_public_internetboolean
is_byokboolean
byok_descriptionstring[]
byok_api_key_help_urlstring nullable
has_user_credentialboolean nullable
source_urlstring nullable
approval_statusstring nullable
Approval status: 'pending_review', 'active', 'rejected'
submitted_bystring nullable
submitted_atstring date-time nullable
reviewed_atstring date-time nullable
review_notesstring nullable