Skip to content

CyberShield Documentation Suite

Welcome to the official documentation for the CyberShield SDK and CyberShield API.
This portal provides installation guides, configuration walkthroughs, code samples, and full reference documentation to help you integrate CyberShield into your applications with ease.

What You Will Find Here

CyberShield SDK

A modular security SDK designed to embed threat detection, file analysis, and system monitoring inside your applications.

Includes:

  • Installation & setup
  • Initialization workflow
  • Configuration options
  • Usage examples
  • Module documentation (Threat Scan, File Analysis, System Monitor)
  • Troubleshooting guidance

➡ Explore: SDK Documentation

CyberShield API

A REST API for performing deep file scans, submitting hashes, retrieving reports, and automating security workflows through HTTPS.

Includes:

  • Authentication
  • Base URL structure
  • Standard request/response formats
  • Error codes
  • Complete endpoint reference (Scan File, Submit Hash, Get Report)

➡ Explore: API Reference

Project Overview (At a Glance)

CyberShield provides two integration paths:

  • Use the SDK if you want to embed security features directly inside your application.
  • Use the API if you need server-side scanning, automated pipelines, or remote threat analysis.

Choose the path that matches your workflow.

Next Steps

To begin using CyberShield, follow one of the recommended paths:

Need Help?

If you encounter issues during implementation:

You’re all set to begin!