Configuration Endpoints

Overview

Configuration endpoints allow you to create, retrieve, update, and delete MCP configurations and their associated servers. Each configuration can contain multiple MCP server definitions with their commands, arguments, environment variables, and guardrail policies.

List All Configurations

Retrieve a list of all MCP configurations.

curl -X GET "http://localhost:8001/api/v1/configs" \
  -H "Authorization: Bearer ${ADMIN_KEY}"

import requests

response = requests.get(
    "http://localhost:8001/api/v1/configs",
    headers={"Authorization": f"Bearer {admin_key}"}
)
configs = response.json()

const response = await fetch('http://localhost:8001/api/v1/configs', {
  headers: { 'Authorization': `Bearer ${adminKey}` }
});
const configs = await response.json();

Response: 200 OK

{
  "message": "Configurations retrieved successfully",
  "data": [
    {
      "mcp_config_id": "550e8400-e29b-41d4-a716-446655440000",
      "mcp_config_name": "development-config",
      "servers": 3,
      "used_by_projects": [
        {
          "project_id": "660e8400-e29b-41d4-a716-446655440000",
          "project_name": "dev-project"
        }
      ]
    }
  ],
  "timestamp": "2024-01-01T12:00:00.000000"
}

array

Show Configuration Object

string

required

Unique identifier for the configuration

string

required

Human-readable name of the configuration

integer

required

Number of servers in this configuration

array

List of projects using this configuration

Create Configuration

Create a new MCP configuration.

curl -X POST "http://localhost:8001/api/v1/configs" \
  -H "Authorization: Bearer ${ADMIN_KEY}" \
  -H "Content-Type: application/json" \
  -d '{"config_name": "production-config"}'

response = requests.post(
    "http://localhost:8001/api/v1/configs",
    headers={"Authorization": f"Bearer {admin_key}"},
    json={"config_name": "production-config"}
)
result = response.json()

string

required

Name for the new configuration

Response: 200 OK

{
  "message": "Configuration created successfully",
  "data": {
    "config_id": "550e8400-e29b-41d4-a716-446655440000",
    "config_name": "production-config"
  },
  "timestamp": "2024-01-01T12:00:00.000000"
}

Get Configuration

Retrieve details of a specific configuration.

curl -X GET "http://localhost:8001/api/v1/configs/{config_identifier}" \
  -H "Authorization: Bearer ${ADMIN_KEY}"

response = requests.get(
    f"http://localhost:8001/api/v1/configs/{config_id}",
    headers={"Authorization": f"Bearer {admin_key}"}
)
config = response.json()

string

required

Configuration ID or name

Response: 200 OK

{
  "message": "Configuration retrieved successfully",
  "data": {
    "mcp_config_id": "550e8400-e29b-41d4-a716-446655440000",
    "mcp_config_name": "production-config",
    "mcp_config": [
      {
        "server_name": "github",
        "description": "GitHub MCP Server",
        "config": {
          "command": "npx",
          "args": ["-y", "@modelcontextprotocol/server-github"]
        },
        "enable_tool_guardrails": true,
        "input_guardrails_policy": {
          "enabled": false
        },
        "output_guardrails_policy": {
          "enabled": false
        }
      }
    ]
  },
  "timestamp": "2024-01-01T12:00:00.000000"
}

Update Configuration Name

Rename an existing configuration.

curl -X PUT "http://localhost:8001/api/v1/configs/{config_identifier}/rename" \
  -H "Authorization: Bearer ${ADMIN_KEY}" \
  -H "Content-Type: application/json" \
  -d '{"new_name": "prod-config-v2"}'

response = requests.put(
    f"http://localhost:8001/api/v1/configs/{config_id}/rename",
    headers={"Authorization": f"Bearer {admin_key}"},
    json={"new_name": "prod-config-v2"}
)

string

required

Configuration ID or name

string

required

New name for the configuration

Response: 200 OK

{
  "message": "Configuration renamed successfully",
  "timestamp": "2024-01-01T12:00:00.000000"
}

Delete Configuration

Delete a configuration (must not be in use by any projects).

curl -X DELETE "http://localhost:8001/api/v1/configs/{config_identifier}" \
  -H "Authorization: Bearer ${ADMIN_KEY}"

response = requests.delete(
    f"http://localhost:8001/api/v1/configs/{config_id}",
    headers={"Authorization": f"Bearer {admin_key}"}
)

string

required

Configuration ID or name

Response: 200 OK

{
  "message": "Configuration deleted successfully",
  "timestamp": "2024-01-01T12:00:00.000000"
}

Copy Configuration

Create a copy of an existing configuration.

curl -X POST "http://localhost:8001/api/v1/configs/copy" \
  -H "Authorization: Bearer ${ADMIN_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "source_config": "production-config",
    "target_config": "staging-config"
  }'

response = requests.post(
    "http://localhost:8001/api/v1/configs/copy",
    headers={"Authorization": f"Bearer {admin_key}"},
    json={
        "source_config": "production-config",
        "target_config": "staging-config"
    }
)

string

required

Source configuration ID or name

string

required

Name for the new configuration

Response: 200 OK

{
  "message": "Configuration copied successfully",
  "timestamp": "2024-01-01T12:00:00.000000"
}

List Servers in Configuration

Get all servers configured in a specific configuration.

curl -X GET "http://localhost:8001/api/v1/configs/{config_identifier}/servers" \
  -H "Authorization: Bearer ${ADMIN_KEY}"

response = requests.get(
    f"http://localhost:8001/api/v1/configs/{config_id}/servers",
    headers={"Authorization": f"Bearer {admin_key}"}
)
servers = response.json()

string

required

Configuration ID or name

Response: 200 OK

{
  "message": "Servers retrieved successfully",
  "data": [
    {
      "server_name": "github",
      "description": "GitHub MCP Server",
      "command": "npx",
      "args": ["-y", "@modelcontextprotocol/server-github"],
      "env": {},
      "enable_tool_guardrails": true
    },
    {
      "server_name": "filesystem",
      "description": "Filesystem MCP Server",
      "command": "npx",
      "args": ["-y", "@modelcontextprotocol/server-filesystem", "/path/to/dir"],
      "env": {},
      "enable_tool_guardrails": true
    }
  ],
  "timestamp": "2024-01-01T12:00:00.000000"
}

Add Server to Configuration

Add a new MCP server to a configuration.

curl -X POST "http://localhost:8001/api/v1/configs/{config_identifier}/servers" \
  -H "Authorization: Bearer ${ADMIN_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "server_name": "github",
    "server_command": "npx",
    "args": ["-y", "@modelcontextprotocol/server-github"],
    "env": {
      "GITHUB_TOKEN": "ghp_xxxxxxxxxxxx"
    },
    "description": "GitHub MCP Server",
    "input_guardrails_policy": {
      "enabled": true,
      "policy_name": "GitHub Input Policy",
      "block": ["policy_violation", "injection_attack"]
    },
    "output_guardrails_policy": {
      "enabled": true,
      "policy_name": "GitHub Output Policy",
      "block": ["policy_violation"]
    }
  }'

response = requests.post(
    f"http://localhost:8001/api/v1/configs/{config_id}/servers",
    headers={"Authorization": f"Bearer {admin_key}"},
    json={
        "server_name": "github",
        "server_command": "npx",
        "args": ["-y", "@modelcontextprotocol/server-github"],
        "env": {"GITHUB_TOKEN": "ghp_xxxxxxxxxxxx"},
        "description": "GitHub MCP Server",
        "input_guardrails_policy": {
            "enabled": True,
            "policy_name": "GitHub Input Policy",
            "block": ["policy_violation", "injection_attack"]
        }
    }
)

string

required

Configuration ID or name

string

required

Unique name for the server within this configuration

string

required

Command to execute the MCP server (e.g., “npx”, “python”, “node”)

array

Command-line arguments for the server

object

Environment variables to pass to the server

object

Tool-specific configuration overrides

string

Human-readable description of the server

object

Input guardrail policy configuration

Show Policy Fields

boolean

Enable input guardrails for this server

string

Name of the guardrail policy

object

Additional guardrail settings (e.g., pii_redaction)

array

List of violation types to block (policy_violation, injection_attack, etc.)

object

Output guardrail policy configuration (same structure as input)

Response: 200 OK

{
  "message": "Server added successfully",
  "timestamp": "2024-01-01T12:00:00.000000"
}

Update Server in Configuration

Update an existing server’s configuration.

curl -X PUT "http://localhost:8001/api/v1/configs/{config_identifier}/servers/{server_name}" \
  -H "Authorization: Bearer ${ADMIN_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "server_command": "python3",
    "args": ["/updated/path/to/server.py"],
    "description": "Updated server description"
  }'

response = requests.put(
    f"http://localhost:8001/api/v1/configs/{config_id}/servers/{server_name}",
    headers={"Authorization": f"Bearer {admin_key}"},
    json={
        "server_command": "python3",
        "args": ["/updated/path/to/server.py"],
        "description": "Updated server description"
    }
)

string

required

Configuration ID or name

string

required

Name of the server to update

string

Updated command (optional)

array

Updated arguments (optional)

object

Updated environment variables (optional)

object

Updated tool configuration (optional)

string

Updated description (optional)

Response: 200 OK

{
  "message": "Server updated successfully",
  "timestamp": "2024-01-01T12:00:00.000000"
}

Remove Server from Configuration

Remove a specific server from a configuration.

curl -X DELETE "http://localhost:8001/api/v1/configs/{config_identifier}/servers/{server_name}" \
  -H "Authorization: Bearer ${ADMIN_KEY}"

response = requests.delete(
    f"http://localhost:8001/api/v1/configs/{config_id}/servers/{server_name}",
    headers={"Authorization": f"Bearer {admin_key}"}
)

string

required

Configuration ID or name

string

required

Name of the server to remove

Response: 200 OK

{
  "message": "Server removed successfully",
  "timestamp": "2024-01-01T12:00:00.000000"
}

Update Server Guardrails

Update both input and output guardrail policies for a server.

curl -X PUT "http://localhost:8001/api/v1/configs/{config_identifier}/servers/{server_name}/guardrails" \
  -H "Authorization: Bearer ${ADMIN_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "input_policy": {
      "enabled": true,
      "policy_name": "Strict Input Policy",
      "additional_config": {
        "pii_redaction": true
      },
      "block": ["policy_violation", "injection_attack", "nsfw"]
    },
    "output_policy": {
      "enabled": true,
      "policy_name": "Strict Output Policy",
      "additional_config": {
        "relevancy": true,
        "hallucination": true
      },
      "block": ["policy_violation", "nsfw"]
    }
  }'

string

required

Configuration ID or name

string

required

Name of the server

object

Input guardrail policy configuration

object

Output guardrail policy configuration

Response: 200 OK

{
  "message": "Guardrails updated successfully",
  "timestamp": "2024-01-01T12:00:00.000000"
}

Validate Configuration

Validate a configuration structure and server definitions.

curl -X POST "http://localhost:8001/api/v1/configs/{config_identifier}/validate" \
  -H "Authorization: Bearer ${ADMIN_KEY}"

response = requests.post(
    f"http://localhost:8001/api/v1/configs/{config_id}/validate",
    headers={"Authorization": f"Bearer {admin_key}"}
)

string

required

Configuration ID or name

Response: 200 OK

{
  "message": "Configuration is valid",
  "timestamp": "2024-01-01T12:00:00.000000"
}

Export Configuration

Export a configuration to a JSON file.

curl -X POST "http://localhost:8001/api/v1/configs/{config_identifier}/export" \
  -H "Authorization: Bearer ${ADMIN_KEY}" \
  -H "Content-Type: application/json" \
  -d '{"output_file": "/path/to/export.json"}'

response = requests.post(
    f"http://localhost:8001/api/v1/configs/{config_id}/export",
    headers={"Authorization": f"Bearer {admin_key}"},
    json={"output_file": "/path/to/export.json"}
)

string

required

Configuration ID or name

string

required

Path where the configuration will be exported

Response: 200 OK

{
  "message": "Configuration exported successfully",
  "timestamp": "2024-01-01T12:00:00.000000"
}

Import Configuration

Import a configuration from a JSON file.

curl -X POST "http://localhost:8001/api/v1/configs/import" \
  -H "Authorization: Bearer ${ADMIN_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "input_file": "/path/to/import.json",
    "config_name": "imported-config"
  }'

response = requests.post(
    "http://localhost:8001/api/v1/configs/import",
    headers={"Authorization": f"Bearer {admin_key}"},
    json={
        "input_file": "/path/to/import.json",
        "config_name": "imported-config"
    }
)

string

required

Path to the configuration file to import

string

required

Name for the imported configuration

Response: 200 OK

{
  "message": "Configuration imported successfully",
  "timestamp": "2024-01-01T12:00:00.000000"
}

Search Configurations

Search configurations by name or content.

curl -X POST "http://localhost:8001/api/v1/configs/search" \
  -H "Authorization: Bearer ${ADMIN_KEY}" \
  -H "Content-Type: application/json" \
  -d '{"search_term": "production"}'

response = requests.post(
    "http://localhost:8001/api/v1/configs/search",
    headers={"Authorization": f"Bearer {admin_key}"},
    json={"search_term": "production"}
)
results = response.json()

string

required

Search query (matches against config names and server names)

Response: 200 OK

{
  "message": "Search completed successfully",
  "data": [
    {
      "mcp_config_id": "550e8400-e29b-41d4-a716-446655440000",
      "mcp_config_name": "production-config",
      "servers": 5
    }
  ],
  "timestamp": "2024-01-01T12:00:00.000000"
}

Next Steps

Project Endpoints

Manage projects and assign configurations

User Endpoints

Create and manage users

API Key Endpoints

Generate and rotate API keys

System Endpoints

System backup and restore

REST API

CLI Reference

Gateway Tools

Plugin API

Overview

List All Configurations

Create Configuration

Get Configuration

Update Configuration Name

Delete Configuration

Copy Configuration

List Servers in Configuration

Add Server to Configuration

Update Server in Configuration

Remove Server from Configuration

Update Server Guardrails

Validate Configuration

Export Configuration

Import Configuration

Search Configurations

Next Steps

Project Endpoints

User Endpoints

API Key Endpoints

System Endpoints

​Overview

​List All Configurations

​Create Configuration

​Get Configuration

​Update Configuration Name

​Delete Configuration

​Copy Configuration

​List Servers in Configuration

​Add Server to Configuration

​Update Server in Configuration

​Remove Server from Configuration

​Update Server Guardrails

​Validate Configuration

​Export Configuration

​Import Configuration

​Search Configurations

​Next Steps

Project Endpoints

User Endpoints

API Key Endpoints

System Endpoints

Overview

List All Configurations

Create Configuration

Get Configuration

Update Configuration Name

Delete Configuration

Copy Configuration

List Servers in Configuration

Add Server to Configuration

Update Server in Configuration

Remove Server from Configuration

Update Server Guardrails

Validate Configuration

Export Configuration

Import Configuration

Search Configurations

Next Steps