Documentation Index
Fetch the complete documentation index at: https://mintlify.com/enkryptai/secure-mcp-gateway/llms.txt
Use this file to discover all available pages before exploring further.
Overview
System commands provide tools for maintaining the gateway infrastructure, including backup and recovery, health monitoring, and system operations.Health Monitoring
System Health Check
Perform a comprehensive health check of the gateway system.- Configuration structure validation
- Orphaned data detection (users not in projects, configs not assigned)
- Duplicate email detection
- Duplicate name warnings
- Reference integrity checks (API keys → users → projects → configs)
- Statistics summary
Run health checks regularly as part of your maintenance routine.
Backup and Recovery
Create System Backup
Create a complete backup of the entire system configuration.Path to output backup file
Backups include all configuration but do NOT include the
admin_apikey for security.Restore from Backup
Restore system configuration from a backup file.Path to backup file
- Validates backup file structure
- Creates automatic backup of current state
- Replaces configuration with backup data
- Verifies restored configuration
Automatic Backups
The system automatically creates backups before major operations:- Filename pattern:
enkrypt_mcp_config.json.bkp.YYYYMMDD_HHMMSS - Location: Same directory as main config file
- Triggered by:
- System restore operations
- Bulk modifications
- Import operations
Reset System
Reset the entire system to default configuration.Required flag to confirm destructive operation
API Server Management
Start API Server
Launch the REST API server for programmatic access.- Host:
0.0.0.0 - Port:
8001 - Docs:
http://localhost:8001/docs - OpenAPI:
http://localhost:8001/openapi.json
See API Reference for available endpoints and authentication.
- Authentication with Bearer tokens
- Automatic OpenAPI documentation
- CORS support
- Request validation
- Rate limiting
- Development
- Production
Configuration Management
Generate Default Config
Generate a new default configuration file.- macOS/Linux:
~/.enkrypt/enkrypt_mcp_config.json - Windows:
%USERPROFILE%\.enkrypt\enkrypt_mcp_config.json - Docker:
/app/.enkrypt/docker/enkrypt_mcp_config.json
- Unique gateway API key
- Secure admin API key (256 characters)
- Default project and user
- Sample echo server configuration
- Plugin configurations (auth, guardrails, telemetry)
Version Information
Display CLI and gateway version information.Best Practices
Backup Strategy
Backup Strategy
Daily backups:Before major changes:
- Always create a backup before:
- Bulk user/project operations
- Configuration imports
- System updates
- Production deployments
- Store backups in version control (without API keys)
- Use encrypted storage for full backups
- Maintain off-site backup copies
- Test restore procedures regularly
Health Monitoring
Health Monitoring
Regular checks:Monitoring schedule:
- Daily: Automated health checks
- Weekly: Manual review of reports
- Monthly: Deep system audit
- Quarterly: Backup restore testing
- Orphaned data detected
- Reference integrity failures
- Duplicate entries found
- Configuration structure errors
Maintenance Windows
Maintenance Windows
Schedule regular maintenance:
- System health checks
- Backup verification
- Log rotation
- Configuration optimization
- Security updates
- Announce maintenance windows
- Provide status updates
- Document changes made
- Test after maintenance
Common Workflows
Daily Backup Script
Weekly Health Check
Disaster Recovery
System Migration
Troubleshooting
Backup file corrupted
Backup file corrupted
Error: “Invalid JSON in backup file”Solution:
Health check failures
Health check failures
Issue: Health check reports errorsActions:
- Review error details
- Fix reported issues
- Re-run health check
- Orphaned users: Remove from system or add to projects
- Invalid references: Fix API keys pointing to non-existent projects
- Duplicate names: Rename conflicting entries
Cannot start API server
Cannot start API server
Error: “Port already in use”Solution:
Restore fails
Restore fails
Error: “Validation failed after restore”Solution:
Monitoring Integration
Prometheus Metrics
Export health metrics for Prometheus monitoring.Log Monitoring
Configure log aggregation for system events.Security Considerations
Admin API KeyThe 256-character
admin_apikey is used for administrative REST API operations. It is:- Automatically generated during
generate-config - NOT included in system backups for security
- Stored only in the main config file
- Required for admin-level API access