Enkrypt AI Secure MCP Gateway

{ "openapi": "3.1.0", "info": { "title": "Enkrypt Secure MCP Gateway API", "description": "REST API for managing MCP configurations, projects, users, and system operations", "version": "2.1.5" }, "servers": [ { "url": "http://localhost:8001", "description": "Local development server" }, { "url": "http://127.0.0.1:8001", "description": "Local development server (IP)" } ], "tags": [ { "name": "Health", "description": "Health check endpoints for monitoring service availability" }, { "name": "Configurations", "description": "MCP configuration management - create, read, update, delete configurations" }, { "name": "Servers", "description": "Server management within configurations - add, update, delete MCP servers" }, { "name": "Guardrails", "description": "Security guardrails - manage input and output policies for servers" }, { "name": "Projects", "description": "Project management - create, read, update, delete projects and manage project users" }, { "name": "Users", "description": "User management - create, read, update, delete users and manage user projects" }, { "name": "API Keys", "description": "API key management - generate, rotate, enable, disable, and delete API keys" }, { "name": "Search", "description": "Search operations across configurations, projects, and users" }, { "name": "Import/Export", "description": "Import and export operations for configurations and projects" }, { "name": "System", "description": "System operations - health checks, backup, restore, and reset" } ], "paths": { "/health": { "get": { "tags": [ "Health" ], "summary": "Health Check", "description": "Health check endpoint.", "operationId": "health_check_health_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } } } } }, "/api/v1/configs": { "get": { "tags": [ "Configurations" ], "summary": "Get Configs", "description": "List all MCP configurations.", "operationId": "get_configs_api_v1_configs_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "400": { "description": "Bad Request - Malformed request syntax", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized - Authentication required or invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden - Insufficient permissions", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity - Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests - Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error - Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Service Unavailable - Service temporarily unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "BearerAuth": [] } ] }, "post": { "tags": [ "Configurations" ], "summary": "Create Config", "description": "Create a new MCP configuration.", "operationId": "create_config_api_v1_configs_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "400": { "description": "Bad Request - Malformed request syntax", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized - Authentication required or invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden - Insufficient permissions", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "409": { "description": "Conflict - Configuration already exists", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity - Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests - Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error - Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Service Unavailable - Service temporarily unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "BearerAuth": [] } ] } }, "/api/v1/configs/copy": { "post": { "tags": [ "Configurations" ], "summary": "Copy Config Endpoint", "description": "Copy an MCP configuration.", "operationId": "copy_config_endpoint_api_v1_configs_copy_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigCopyRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "BearerAuth": [] } ] } }, "/api/v1/configs/{config_identifier}/rename": { "put": { "tags": [ "Configurations" ], "summary": "Rename Config Endpoint", "description": "Rename an MCP configuration.", "operationId": "rename_config_endpoint_api_v1_configs__config_identifier__rename_put", "parameters": [ { "name": "config_identifier", "in": "path", "required": true, "schema": { "type": "string", "title": "Config Identifier" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigRenameRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "BearerAuth": [] } ] } }, "/api/v1/configs/{config_identifier}": { "get": { "tags": [ "Configurations" ], "summary": "Get Config Endpoint", "description": "Get a specific MCP configuration.", "operationId": "get_config_endpoint_api_v1_configs__config_identifier__get", "parameters": [ { "name": "config_identifier", "in": "path", "required": true, "schema": { "type": "string", "title": "Config Identifier" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "BearerAuth": [] } ] }, "delete": { "tags": [ "Configurations" ], "summary": "Delete Config Endpoint", "description": "Delete an MCP configuration.", "operationId": "delete_config_endpoint_api_v1_configs__config_identifier__delete", "parameters": [ { "name": "config_identifier", "in": "path", "required": true, "schema": { "type": "string", "title": "Config Identifier" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "BearerAuth": [] } ] } }, "/api/v1/configs/{config_identifier}/projects": { "get": { "tags": [ "Configurations" ], "summary": "Get Config Projects", "description": "List projects using a specific configuration.", "operationId": "get_config_projects_api_v1_configs__config_identifier__projects_get", "parameters": [ { "name": "config_identifier", "in": "path", "required": true, "schema": { "type": "string", "title": "Config Identifier" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "BearerAuth": [] } ] } }, "/api/v1/configs/{config_identifier}/servers": { "get": { "tags": [ "Configurations" ], "summary": "Get Config Servers", "description": "List servers in a specific configuration.", "operationId": "get_config_servers_api_v1_configs__config_identifier__servers_get", "parameters": [ { "name": "config_identifier", "in": "path", "required": true, "schema": { "type": "string", "title": "Config Identifier" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "BearerAuth": [] } ] }, "post": { "tags": [ "Servers" ], "summary": "Add Server To Config Endpoint", "description": "Add a server to a configuration.", "operationId": "add_server_to_config_endpoint_api_v1_configs__config_identifier__servers_post", "parameters": [ { "name": "config_identifier", "in": "path", "required": true, "schema": { "type": "string", "title": "Config Identifier" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServerAddRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "BearerAuth": [] } ] }, "delete": { "tags": [ "Servers" ], "summary": "Delete All Servers From Config Endpoint", "description": "Remove all servers from a configuration.", "operationId": "delete_all_servers_from_config_endpoint_api_v1_configs__config_identifier__servers_delete", "parameters": [ { "name": "config_identifier", "in": "path", "required": true, "schema": { "type": "string", "title": "Config Identifier" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "BearerAuth": [] } ] } }, "/api/v1/configs/{config_identifier}/servers/{server_name}": { "get": { "tags": [ "Configurations" ], "summary": "Get Config Server Endpoint", "description": "Get specific server details from a configuration.", "operationId": "get_config_server_endpoint_api_v1_configs__config_identifier__servers__server_name__get", "parameters": [ { "name": "config_identifier", "in": "path", "required": true, "schema": { "type": "string", "title": "Config Identifier" } }, { "name": "server_name", "in": "path", "required": true, "schema": { "type": "string", "title": "Server Name" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "BearerAuth": [] } ] }, "put": { "tags": [ "Configurations" ], "summary": "Update Server In Config Endpoint", "description": "Update a server in a configuration.", "operationId": "update_server_in_config_endpoint_api_v1_configs__config_identifier__servers__server_name__put", "parameters": [ { "name": "config_identifier", "in": "path", "required": true, "schema": { "type": "string", "title": "Config Identifier" } }, { "name": "server_name", "in": "path", "required": true, "schema": { "type": "string", "title": "Server Name" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServerUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "BearerAuth": [] } ] }, "delete": { "tags": [ "Configurations" ], "summary": "Delete Server From Config Endpoint", "description": "Remove a server from a configuration.", "operationId": "delete_server_from_config_endpoint_api_v1_configs__config_identifier__servers__server_name__delete", "parameters": [ { "name": "config_identifier", "in": "path", "required": true, "schema": { "type": "string", "title": "Config Identifier" } }, { "name": "server_name", "in": "path", "required": true, "schema": { "type": "string", "title": "Server Name" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "BearerAuth": [] } ] } }, "/api/v1/configs/{config_identifier}/validate": { "post": { "summary": "Validate Config Endpoint", "description": "Validate a configuration.", "operationId": "validate_config_endpoint_api_v1_configs__config_identifier__validate_post", "parameters": [ { "name": "config_identifier", "in": "path", "required": true, "schema": { "type": "string", "title": "Config Identifier" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "BearerAuth": [] } ], "tags": [ "Configurations" ] } }, "/api/v1/configs/{config_identifier}/export": { "post": { "tags": [ "Configurations" ], "summary": "Export Config Endpoint", "description": "Export a configuration to file.", "operationId": "export_config_endpoint_api_v1_configs__config_identifier__export_post", "parameters": [ { "name": "config_identifier", "in": "path", "required": true, "schema": { "type": "string", "title": "Config Identifier" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigExportRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "BearerAuth": [] } ] } }, "/api/v1/configs/import": { "post": { "tags": [ "Configurations" ], "summary": "Import Config Endpoint", "description": "Import a configuration from file.", "operationId": "import_config_endpoint_api_v1_configs_import_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigImportRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "BearerAuth": [] } ] } }, "/api/v1/configs/search": { "post": { "tags": [ "Search" ], "summary": "Search Configs Endpoint", "description": "Search MCP configurations by name or other configuration metadata. Returns all matching configurations.", "operationId": "search_configs_endpoint_api_v1_configs_search_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigSearchRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "400": { "description": "Bad Request - Invalid request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized - Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden - Insufficient permissions", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "500": { "description": "Internal Server Error - Server encountered an error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Service Unavailable - Service temporarily unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "BearerAuth": [] } ] } }, "/api/v1/configs/{config_identifier}/servers/{server_name}/input-guardrails": { "put": { "tags": [ "Configurations" ], "summary": "Update Server Input Guardrails Endpoint", "description": "Update server input guardrails policy.", "operationId": "update_server_input_guardrails_endpoint_api_v1_configs__config_identifier__servers__server_name__input_guardrails_put", "parameters": [ { "name": "config_identifier", "in": "path", "required": true, "schema": { "type": "string", "title": "Config Identifier" } }, { "name": "server_name", "in": "path", "required": true, "schema": { "type": "string", "title": "Server Name" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuardrailsUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "BearerAuth": [] } ] } }, "/api/v1/configs/{config_identifier}/servers/{server_name}/output-guardrails": { "put": { "tags": [ "Configurations" ], "summary": "Update Server Output Guardrails Endpoint", "description": "Update server output guardrails policy.", "operationId": "update_server_output_guardrails_endpoint_api_v1_configs__config_identifier__servers__server_name__output_guardrails_put", "parameters": [ { "name": "config_identifier", "in": "path", "required": true, "schema": { "type": "string", "title": "Config Identifier" } }, { "name": "server_name", "in": "path", "required": true, "schema": { "type": "string", "title": "Server Name" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuardrailsUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "BearerAuth": [] } ] } }, "/api/v1/configs/{config_identifier}/servers/{server_name}/guardrails": { "put": { "tags": [ "Configurations" ], "summary": "Update Server Guardrails Endpoint", "description": "Update server guardrails policies (both input and output).", "operationId": "update_server_guardrails_endpoint_api_v1_configs__config_identifier__servers__server_name__guardrails_put", "parameters": [ { "name": "config_identifier", "in": "path", "required": true, "schema": { "type": "string", "title": "Config Identifier" } }, { "name": "server_name", "in": "path", "required": true, "schema": { "type": "string", "title": "Server Name" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CombinedGuardrailsUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "BearerAuth": [] } ] } }, "/api/v1/projects": { "get": { "summary": "Get Projects", "description": "List all projects.", "operationId": "get_projects_api_v1_projects_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "BearerAuth": [] } ], "tags": [ "Projects" ] }, "post": { "summary": "Create Project Endpoint", "description": "Create a new project.", "operationId": "create_project_endpoint_api_v1_projects_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "BearerAuth": [] } ], "tags": [ "Projects" ] } }, "/api/v1/projects/{project_identifier}": { "get": { "summary": "Get Project Endpoint", "description": "Get a specific project.", "operationId": "get_project_endpoint_api_v1_projects__project_identifier__get", "parameters": [ { "name": "project_identifier", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Identifier" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "BearerAuth": [] } ], "tags": [ "Projects" ] }, "delete": { "summary": "Delete Project Endpoint", "description": "Delete a project.", "operationId": "delete_project_endpoint_api_v1_projects__project_identifier__delete", "parameters": [ { "name": "project_identifier", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Identifier" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "BearerAuth": [] } ], "tags": [ "Projects" ] } }, "/api/v1/projects/{project_identifier}/assign-config": { "post": { "summary": "Assign Config To Project Endpoint", "description": "Assign a configuration to a project.", "operationId": "assign_config_to_project_endpoint_api_v1_projects__project_identifier__assign_config_post", "parameters": [ { "name": "project_identifier", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Identifier" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectAssignConfigRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "BearerAuth": [] } ], "tags": [ "Projects" ] } }, "/api/v1/projects/{project_identifier}/unassign-config": { "post": { "summary": "Unassign Config From Project Endpoint", "description": "Unassign configuration from a project.", "operationId": "unassign_config_from_project_endpoint_api_v1_projects__project_identifier__unassign_config_post", "parameters": [ { "name": "project_identifier", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Identifier" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "BearerAuth": [] } ], "tags": [ "Projects" ] } }, "/api/v1/projects/{project_identifier}/config": { "get": { "summary": "Get Project Config Endpoint", "description": "Get configuration assigned to a project.", "operationId": "get_project_config_endpoint_api_v1_projects__project_identifier__config_get", "parameters": [ { "name": "project_identifier", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Identifier" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "BearerAuth": [] } ], "tags": [ "Projects" ] } }, "/api/v1/projects/{project_identifier}/users": { "get": { "summary": "Get Project Users", "description": "List users in a project.", "operationId": "get_project_users_api_v1_projects__project_identifier__users_get", "parameters": [ { "name": "project_identifier", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Identifier" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "BearerAuth": [] } ], "tags": [ "Projects" ] }, "post": { "summary": "Add User To Project Endpoint", "description": "Add a user to a project.", "operationId": "add_user_to_project_endpoint_api_v1_projects__project_identifier__users_post", "parameters": [ { "name": "project_identifier", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Identifier" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectAddUserRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "BearerAuth": [] } ], "tags": [ "Projects" ] }, "delete": { "summary": "Remove All Users From Project Endpoint", "description": "Remove all users from a project.", "operationId": "remove_all_users_from_project_endpoint_api_v1_projects__project_identifier__users_delete", "parameters": [ { "name": "project_identifier", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Identifier" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "BearerAuth": [] } ], "tags": [ "Projects" ] } }, "/api/v1/projects/{project_identifier}/users/{user_identifier}": { "delete": { "summary": "Remove User From Project Endpoint", "description": "Remove a user from a project.", "operationId": "remove_user_from_project_endpoint_api_v1_projects__project_identifier__users__user_identifier__delete", "parameters": [ { "name": "project_identifier", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Identifier" } }, { "name": "user_identifier", "in": "path", "required": true, "schema": { "type": "string", "title": "User Identifier" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "BearerAuth": [] } ], "tags": [ "Projects" ] } }, "/api/v1/projects/{project_identifier}/export": { "post": { "tags": [ "Projects" ], "summary": "Export Project Endpoint", "description": "Export a project and its associated MCP configuration to a JSON file. The export includes project metadata, users, and the complete MCP configuration with all servers.", "operationId": "export_project_endpoint_api_v1_projects__project_identifier__export_post", "parameters": [ { "name": "project_identifier", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Identifier" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectExportRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "400": { "description": "Bad Request - Invalid request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized - Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden - Insufficient permissions", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found - Project does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "500": { "description": "Internal Server Error - Server encountered an error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Service Unavailable - Service temporarily unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "BearerAuth": [] } ] } }, "/api/v1/projects/search": { "post": { "tags": [ "Search" ], "summary": "Search Projects Endpoint", "description": "Search projects by name or other project metadata. Returns all matching projects.", "operationId": "search_projects_endpoint_api_v1_projects_search_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectSearchRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "400": { "description": "Bad Request - Invalid request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized - Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden - Insufficient permissions", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "500": { "description": "Internal Server Error - Server encountered an error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Service Unavailable - Service temporarily unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "BearerAuth": [] } ] } }, "/api/v1/users": { "get": { "summary": "Get Users", "description": "List all users.", "operationId": "get_users_api_v1_users_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "BearerAuth": [] } ], "tags": [ "Users" ] }, "post": { "summary": "Create User Endpoint", "description": "Create a new user.", "operationId": "create_user_endpoint_api_v1_users_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "BearerAuth": [] } ], "tags": [ "Users" ] } }, "/api/v1/users/{user_identifier}": { "get": { "summary": "Get User Endpoint", "description": "Get a specific user.", "operationId": "get_user_endpoint_api_v1_users__user_identifier__get", "parameters": [ { "name": "user_identifier", "in": "path", "required": true, "schema": { "type": "string", "title": "User Identifier" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "BearerAuth": [] } ], "tags": [ "Users" ] }, "put": { "summary": "Update User Endpoint", "description": "Update a user.", "operationId": "update_user_endpoint_api_v1_users__user_identifier__put", "parameters": [ { "name": "user_identifier", "in": "path", "required": true, "schema": { "type": "string", "title": "User Identifier" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "BearerAuth": [] } ], "tags": [ "Users" ] }, "delete": { "summary": "Delete User Endpoint", "description": "Delete a user.", "operationId": "delete_user_endpoint_api_v1_users__user_identifier__delete", "parameters": [ { "name": "user_identifier", "in": "path", "required": true, "schema": { "type": "string", "title": "User Identifier" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDeleteRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "BearerAuth": [] } ], "tags": [ "Users" ] } }, "/api/v1/users/{user_identifier}/projects": { "get": { "summary": "Get User Projects", "description": "List projects for a specific user.", "operationId": "get_user_projects_api_v1_users__user_identifier__projects_get", "parameters": [ { "name": "user_identifier", "in": "path", "required": true, "schema": { "type": "string", "title": "User Identifier" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "BearerAuth": [] } ], "tags": [ "Projects" ] } }, "/api/v1/users/{user_identifier}/api-keys": { "post": { "summary": "Generate User Api Key Endpoint", "description": "Generate an API key for a user.", "operationId": "generate_user_api_key_endpoint_api_v1_users__user_identifier__api_keys_post", "parameters": [ { "name": "user_identifier", "in": "path", "required": true, "schema": { "type": "string", "title": "User Identifier" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserGenerateApiKeyRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "BearerAuth": [] } ], "tags": [ "API Keys" ] }, "get": { "summary": "Get User Api Keys", "description": "List API keys for a user.", "operationId": "get_user_api_keys_api_v1_users__user_identifier__api_keys_get", "parameters": [ { "name": "user_identifier", "in": "path", "required": true, "schema": { "type": "string", "title": "User Identifier" } }, { "name": "project_identifier", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Project Identifier" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "BearerAuth": [] } ], "tags": [ "API Keys" ] }, "delete": { "summary": "Delete All User Api Keys Endpoint", "description": "Delete all API keys for a user.", "operationId": "delete_all_user_api_keys_endpoint_api_v1_users__user_identifier__api_keys_delete", "parameters": [ { "name": "user_identifier", "in": "path", "required": true, "schema": { "type": "string", "title": "User Identifier" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "BearerAuth": [] } ], "tags": [ "API Keys" ] } }, "/api/v1/api-keys": { "get": { "summary": "Get All Api Keys", "description": "List all API keys across all users.", "operationId": "get_all_api_keys_api_v1_api_keys_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "BearerAuth": [] } ], "tags": [ "API Keys" ] } }, "/api/v1/api-keys/rotate": { "post": { "summary": "Rotate Api Key Endpoint", "description": "Rotate an existing API key. Generates a new API key to replace the old one while maintaining the same user and project associations.", "operationId": "rotate_api_key_endpoint_api_v1_api_keys_rotate_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiKeyRotateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "400": { "description": "Bad Request - Invalid request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized - Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden - Insufficient permissions", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found - API key does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "500": { "description": "Internal Server Error - Server encountered an error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Service Unavailable - Service temporarily unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "BearerAuth": [] } ], "tags": [ "API Keys" ] } }, "/api/v1/api-keys/{api_key}/disable": { "post": { "summary": "Disable Api Key Endpoint", "description": "Disable an API key.", "operationId": "disable_api_key_endpoint_api_v1_api_keys__api_key__disable_post", "parameters": [ { "name": "api_key", "in": "path", "required": true, "schema": { "type": "string", "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "BearerAuth": [] } ], "tags": [ "API Keys" ] } }, "/api/v1/api-keys/{api_key}/enable": { "post": { "summary": "Enable Api Key Endpoint", "description": "Enable an API key.", "operationId": "enable_api_key_endpoint_api_v1_api_keys__api_key__enable_post", "parameters": [ { "name": "api_key", "in": "path", "required": true, "schema": { "type": "string", "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "BearerAuth": [] } ], "tags": [ "API Keys" ] } }, "/api/v1/api-keys/{api_key}": { "delete": { "summary": "Delete Api Key Endpoint", "description": "Delete an API key.", "operationId": "delete_api_key_endpoint_api_v1_api_keys__api_key__delete", "parameters": [ { "name": "api_key", "in": "path", "required": true, "schema": { "type": "string", "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "BearerAuth": [] } ], "tags": [ "API Keys" ] } }, "/api/v1/users/search": { "post": { "tags": [ "Search" ], "summary": "Search Users Endpoint", "description": "Search users by email or other user metadata. Returns all matching users.", "operationId": "search_users_endpoint_api_v1_users_search_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserSearchRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "400": { "description": "Bad Request - Invalid request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized - Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden - Insufficient permissions", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "500": { "description": "Internal Server Error - Server encountered an error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Service Unavailable - Service temporarily unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "BearerAuth": [] } ] } }, "/api/v1/system/health": { "get": { "summary": "System Health Check Endpoint", "description": "Check system health.", "operationId": "system_health_check_endpoint_api_v1_system_health_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "BearerAuth": [] } ], "tags": [ "Health" ] } }, "/api/v1/system/backup": { "post": { "summary": "System Backup Endpoint", "description": "Backup system configuration.", "operationId": "system_backup_endpoint_api_v1_system_backup_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SystemBackupRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "BearerAuth": [] } ], "tags": [ "System" ] } }, "/api/v1/system/restore": { "post": { "summary": "System Restore Endpoint", "description": "Restore system configuration.", "operationId": "system_restore_endpoint_api_v1_system_restore_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SystemRestoreRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "BearerAuth": [] } ], "tags": [ "System" ] } }, "/api/v1/system/reset": { "post": { "summary": "System Reset Endpoint", "description": "Reset system configuration.", "operationId": "system_reset_endpoint_api_v1_system_reset_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SystemResetRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "BearerAuth": [] } ], "tags": [ "System" ] } } }, "components": { "schemas": { "ApiKeyRotateRequest": { "properties": { "api_key": { "type": "string", "title": "Api Key", "description": "The API key to rotate (will be replaced with a new key)" } }, "type": "object", "required": [ "api_key" ], "title": "ApiKeyRotateRequest", "example": { "api_key": "your-existing-api-key-here" } }, "CombinedGuardrailsUpdateRequest": { "properties": { "input_policy_file": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Input Policy File" }, "input_policy": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Input Policy" }, "output_policy_file": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Output Policy File" }, "output_policy": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Output Policy" } }, "type": "object", "title": "CombinedGuardrailsUpdateRequest" }, "ConfigCopyRequest": { "properties": { "source_config": { "type": "string", "title": "Source Config" }, "target_config": { "type": "string", "title": "Target Config" } }, "type": "object", "required": [ "source_config", "target_config" ], "title": "ConfigCopyRequest" }, "ConfigCreateRequest": { "properties": { "config_name": { "type": "string", "title": "Config Name" } }, "type": "object", "required": [ "config_name" ], "title": "ConfigCreateRequest" }, "ConfigExportRequest": { "properties": { "output_file": { "type": "string", "title": "Output File" } }, "type": "object", "required": [ "output_file" ], "title": "ConfigExportRequest" }, "ConfigImportRequest": { "properties": { "input_file": { "type": "string", "title": "Input File" }, "config_name": { "type": "string", "title": "Config Name" } }, "type": "object", "required": [ "input_file", "config_name" ], "title": "ConfigImportRequest" }, "ConfigRenameRequest": { "properties": { "new_name": { "type": "string", "title": "New Name" } }, "type": "object", "required": [ "new_name" ], "title": "ConfigRenameRequest" }, "ConfigSearchRequest": { "properties": { "search_term": { "type": "string", "title": "Search Term" } }, "type": "object", "required": [ "search_term" ], "title": "ConfigSearchRequest" }, "GuardrailsUpdateRequest": { "properties": { "policy_file": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Policy File" }, "policy": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Policy" } }, "type": "object", "title": "GuardrailsUpdateRequest" }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" }, "ErrorResponse": { "properties": { "error": { "type": "string", "title": "Error" }, "message": { "type": "string", "title": "Message" }, "status_code": { "type": "integer", "title": "Status Code" }, "timestamp": { "type": "string", "title": "Timestamp" } }, "type": "object", "required": [ "error", "message", "status_code" ], "title": "ErrorResponse" }, "ProjectAddUserRequest": { "properties": { "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Id" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email" } }, "type": "object", "title": "ProjectAddUserRequest" }, "ProjectAssignConfigRequest": { "properties": { "config_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Config Name" }, "config_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Config Id" } }, "type": "object", "title": "ProjectAssignConfigRequest" }, "ProjectCreateRequest": { "properties": { "project_name": { "type": "string", "title": "Project Name" } }, "type": "object", "required": [ "project_name" ], "title": "ProjectCreateRequest" }, "ProjectExportRequest": { "properties": { "output_file": { "type": "string", "title": "Output File", "description": "Full path where the project export file will be saved", "example": "C:/Users/username/exports/my_project.json" } }, "type": "object", "required": [ "output_file" ], "title": "ProjectExportRequest", "example": { "output_file": "C:/Users/username/exports/my_project.json" } }, "ProjectSearchRequest": { "properties": { "search_term": { "type": "string", "title": "Search Term" } }, "type": "object", "required": [ "search_term" ], "title": "ProjectSearchRequest" }, "ServerAddRequest": { "properties": { "server_name": { "type": "string", "title": "Server Name" }, "server_command": { "type": "string", "title": "Server Command" }, "args": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Args", "default": [] }, "env": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Env" }, "tools": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Tools" }, "description": { "type": "string", "title": "Description", "default": "" }, "input_guardrails_policy": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Input Guardrails Policy" }, "output_guardrails_policy": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Output Guardrails Policy" } }, "type": "object", "required": [ "server_name", "server_command" ], "title": "ServerAddRequest" }, "ServerUpdateRequest": { "properties": { "server_command": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Server Command" }, "args": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Args" }, "env": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Env" }, "tools": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Tools" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" } }, "type": "object", "title": "ServerUpdateRequest" }, "SuccessResponse": { "properties": { "message": { "type": "string", "title": "Message" }, "data": { "anyOf": [ {}, { "type": "null" } ], "title": "Data" }, "timestamp": { "type": "string", "title": "Timestamp" } }, "type": "object", "required": [ "message" ], "title": "SuccessResponse" }, "SystemBackupRequest": { "properties": { "output_file": { "type": "string", "title": "Output File" } }, "type": "object", "required": [ "output_file" ], "title": "SystemBackupRequest" }, "SystemResetRequest": { "properties": { "confirm": { "type": "boolean", "title": "Confirm", "default": false } }, "type": "object", "title": "SystemResetRequest" }, "SystemRestoreRequest": { "properties": { "input_file": { "type": "string", "title": "Input File" } }, "type": "object", "required": [ "input_file" ], "title": "SystemRestoreRequest" }, "UserCreateRequest": { "properties": { "email": { "type": "string", "format": "email", "title": "Email" } }, "type": "object", "required": [ "email" ], "title": "UserCreateRequest" }, "UserDeleteRequest": { "properties": { "force": { "type": "boolean", "title": "Force", "default": false } }, "type": "object", "title": "UserDeleteRequest" }, "UserGenerateApiKeyRequest": { "properties": { "project_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Project Name" }, "project_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Project Id" } }, "type": "object", "title": "UserGenerateApiKeyRequest" }, "UserSearchRequest": { "properties": { "search_term": { "type": "string", "title": "Search Term" } }, "type": "object", "required": [ "search_term" ], "title": "UserSearchRequest" }, "UserUpdateRequest": { "properties": { "new_email": { "type": "string", "format": "email", "title": "New Email" } }, "type": "object", "required": [ "new_email" ], "title": "UserUpdateRequest" }, "ValidationError": { "properties": { "loc": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "type": "array", "title": "Location" }, "msg": { "type": "string", "title": "Message" }, "type": { "type": "string", "title": "Error Type" } }, "type": "object", "required": [ "loc", "msg", "type" ], "title": "ValidationError" } }, "securitySchemes": { "BearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" } } } }