Documentation
API & SDK Documentation
Integrate Sirius Scan's powerful vulnerability scanning capabilities into your applications using our REST API or official Go SDK.
RESTful API with comprehensive endpoints
Official Go SDK for native integration
Integration Options
REST API
Direct HTTP access to all Sirius Scan features through RESTful endpoints.
- OpenAPI/Swagger specification
- Comprehensive Postman collection
- API key authentication
Go SDK
Official Go SDK for native language integration and application development.
- Type-safe API bindings
- Automatic retries and error handling
- Concurrent scanning support
Quick Example
Get started with Sirius Scan using our Go SDK:
Basic Usage
package main
import (
"log"
"github.com/SiriusScan/go-api/sirius"
"github.com/SiriusScan/go-api/sirius/host"
)
func main() {
// Initialize a new host
newHost := sirius.Host{
IP: "192.168.1.1",
Hostname: "example-host",
OS: "Linux",
OSVersion: "Ubuntu 20.04",
}
// Add host to database
if err := host.AddHost(newHost); err != nil {
log.Fatalf("Failed to add host: %v", err)
}
log.Printf("Successfully added host: %s", newHost.Hostname)
}Core Features
Host Management
Comprehensive host tracking with detailed system information. Add, update, and manage target hosts with support for:
- Host discovery and fingerprinting
- OS and version detection
- Port and service enumeration
- Risk scoring and metrics
Vulnerability Management
Advanced vulnerability assessment capabilities integrated with NVD. Features include:
- CVE tracking and updates
- CVSS scoring (v2.0-v4.0)
- CPE configuration matching
- Detailed vulnerability descriptions
Advanced Features
Enterprise-grade features for scalable scanning operations:
- Message queue integration
- Key-value store for state management
- Automatic connection retry
- Context-aware operations