Documentation

Complete guide to PQSwitch API, quantum vulnerability scanning, and post-quantum cryptography migration strategies.

Quick Start Guide

Get up and running with quantum vulnerability scanning in minutes

2 min

1. Sign Up & Connect

Create account and connect your GitHub, GitLab, or Bitbucket

1 min

2. Add Repository

Add your first repository for quantum vulnerability scanning

5-30 min

3. Start Scanning

Launch your first quantum security scan

10 min

4. Review & Fix

Analyze findings and apply recommended patches

Comprehensive Guides

In-depth tutorials covering all aspects of quantum-safe development

Basics
15 min read

Getting Started Guide

Complete walkthrough from account creation to first scan results

  • Account setup and organization creation
  • Repository connection and synchronization
  • Understanding scan types (quick, normal, audit)
  • Reading vulnerability reports and risk scores
  • Managing team members and permissions
Public Data
10 min read

Public Observatory

Access quantum vulnerability data for open source projects

  • Browsing community-driven vulnerability assessments
  • Understanding quantum readiness scores
  • Contributing to the public knowledge base
  • Accessing scan results without authentication
  • Filtering and searching repository data
Development
20 min read

API Integration

Integrate PQSwitch into your CI/CD pipeline and workflows

  • JWT authentication and API key management
  • Automated scanning with webhooks
  • CI/CD pipeline integration examples
  • Intelligent scanning recommendations
  • Real-time scan monitoring
Advanced
25 min read

Advanced Scanning

Optimize scans with intelligent scheduling and activity analysis

  • Activity-based scan recommendations
  • Scheduled scanning configuration
  • Repository activity analysis
  • Resource optimization strategies
  • Custom scan configurations

Language Support

Advanced quantum vulnerability detection with v2.0.0 enhanced scanner across multiple languages

C
Full Support
Complete cryptographic library analysis
C++
Full Support
Advanced template and STL support
Go
Full Support
Comprehensive standard library coverage
Python
Full Support
Deep package ecosystem analysis
JavaScript
Full Support
Node.js and browser crypto detection
TypeScript
Full Support
Type-aware vulnerability analysis
Java
Full Support
Enterprise framework integration
C#
Full Support
.NET ecosystem and NuGet analysis
Rust
Beta Support
Cargo crate security analysis
Ruby
Beta Support
Gem vulnerability detection
PHP
Beta Support
Composer package scanning
Swift
Planned
iOS/macOS security frameworks
Kotlin
Planned
Android crypto implementation
Scala
Planned
JVM interop analysis

v2.0.0 Scanner Enhancements

Enhanced layered detection (L0/L1/L2), ML-powered intelligence, 50-100x performance improvements, and ~75% reduction in false positives with context-aware analysis.

Don't see your language? We're continuously expanding our support.

API Reference

Complete REST API with 60+ endpoints for quantum vulnerability scanning and management

Public Observatory (No Authentication)

Access community-driven quantum vulnerability assessments for open source projects

GET
/public/organizations

List public organizations (no auth required)

GET
/public/organizations/{id}/repositories

Browse public repositories and quantum assessments

GET
/public/organizations/{id}/findings

View public security findings and vulnerabilities

GET
/public/observatory/search

Search across all public repositories

Authentication & Security

Secure your API access with JWT tokens and API keys

JWT Authentication

Use JWT Bearer tokens for user authentication in web applications

Authorization Header

Authorization: Bearer YOUR_JWT_TOKEN

Organization Context

X-Organization-ID: your-org-uuid
  • • Secure user authentication
  • • Multi-organization support
  • • Role-based access control
  • • Automatic token refresh

API Key Authentication

Use API keys for service-to-service and CLI integration

API Key Header

X-API-Key: YOUR_API_KEY
  • • Server-to-server communication
  • • CI/CD pipeline integration
  • • No expiration management required
  • • Scoped permissions

Community & Support

Join our growing community of quantum-safe developers

Discord Community

Join developers building quantum-safe applications. Get help, share insights, and collaborate on security.

GitHub Repository

Contribute to open-source components, report issues, and access example integrations.

Help Center

Access detailed guides, troubleshooting tips, and best practices for quantum-safe development.

Ready to Start Scanning?

Begin your quantum-safe journey with comprehensive vulnerability scanning and migration tools.