Troubleshooting¶
This guide covers common issues you may encounter while using the CyberShield SDK, along with recommended solutions.
SDK Not Initializing¶
Cause¶
- Missing or invalid API key
- Incorrect environment setting
- Network restrictions blocking backend access
Fix¶
const shield = new CyberShield({
apiKey: "VALID_KEY",
environment: "sandbox"
});
Ensure your key is correct and belongs to the correct environment.
File Scan Fails¶
Possible Causes¶
- File size exceeds maximum limit
- Unsupported file type
- Network timeout during upload
- Offline mode enabled without local signatures
Fix¶
Increase timeout:
scanTimeout: 10000
Check file type and size.
Slow Scan Performance¶
Possible Causes¶
- Large files being scanned repeatedly
- Caching disabled
- High-latency network connections
Fix¶
Enable caching:
cacheResults: true
Python SDK Throws “Module Not Found”¶
Cause¶
Package not installed correctly.
Fix¶
pip install cybershield-sdk
JavaScript SDK Throws “CyberShield is not a constructor”¶
Cause¶
Incorrect import syntax.
Fix¶
import CyberShield from "cybershield-sdk";
Monitoring Not Returning Alerts¶
Possible Causes¶
- No suspicious processes detected
- Monitor permissions are restricted
- Monitoring disabled in configuration
Fix¶
enableOfflineMode: false
And ensure monitoring is supported on your platform.
Still Having Issues?¶
If none of the above steps resolve your issue:
- Verify your API key permissions
- Check system logs or browser console
- Contact CyberShield support team
Final Notes¶
You have now reached the end of the CyberShield SDK documentation.
With installation, initialization, configuration, usage patterns, and module-level capabilities covered, you should be fully prepared to embed CyberShield’s security features directly into your applications. Use the SDK to integrate local scanning, file analysis, and system monitoring workflows that enhance detection accuracy and strengthen your overall security ecosystem.