CyberShield API Overview¶
Welcome to the CyberShield API Reference, a RESTful interface for performing threat scans, submitting hashes, retrieving analytical reports, and integrating CyberShield’s security capabilities into any application.
This section provides:
- Authentication workflow
- Request/response structures
- Endpoint definitions
- Error codes and troubleshooting patterns
Use this API when you want server-side or automated scanning without embedding the SDK.
Key Capabilities¶
| Capability | Description |
|---|---|
| File Scanning | Upload files for deep threat analysis using CyberShield’s detection engine. |
| Hash Lookup | Submit file hashes (MD5, SHA-1, SHA-256) to quickly retrieve known results. |
| Report Retrieval | Fetch detailed scan reports, threat scores, metadata, and risk indicators. |
| Consistent Response Format | All endpoints follow a unified JSON structure for predictable parsing. |
Before You Begin¶
You will need:
- A valid CyberShield API Key
- Access to CyberShield’s backend (Production or Sandbox)
- Basic understanding of HTTP requests (GET / POST / headers)
- A preferred tool for testing (Postman, curl, your backend framework)
Base URL¶
All CyberShield API requests begin with one of the following environment URLs:
| Environment | Base URL | Purpose |
|---|---|---|
| Production | https://api.cybershield.com |
For real workloads and deployed applications |
| Sandbox | https://sandbox.cybershield.com |
For testing, validation, and safe development |
All endpoints are appended to the selected base URL.
Example:
POST https://api.cybershield.com/scan/file
What’s Next?¶
After completing the API overview, continue with the recommended workflow:
Authentication¶
Endpoints¶
The CyberShield API provides the following core operations: