This page provides a comprehensive list of all available endpoints in the Sirius Scan REST API. The API follows REST principles and uses standard HTTP methods.
All API requests should be made to:
http://localhost:9001
For production deployments, replace localhost:9001 with your Sirius Scan instance URL.
Start a new vulnerability scan for specified targets.
{
"id": "scan-123",
"targets": [
{
"value": "192.168.123.188",
"type": "single_ip"
}
],
"options": {
"template": "quick"
},
"priority": 3
}
| Field | Type | Description |
|---|---|---|
id | string | Custom identifier for the scan |
targets | array | List of targets to scan |
targets[].value | string | Target value (IP, hostname, etc.) |
targets[].type | string | Type of target (single_ip, etc.) |
options.template | string | Scan template to use (quick, etc.) |
priority | number | Scan priority level (1-5) |
curl -X POST "http://localhost:9001/app/scan" \
-H "Content-Type: application/json" \
-d '{
"id": "scan-123",
"targets": [
{
"value": "192.168.123.188",
"type": "single_ip"
}
],
"options": {
"template": "quick"
},
"priority": 3
}'
{
"status": "Message sent successfully"
}
Sirius Scan integrates with the National Vulnerability Database to enrich vulnerability data. The Go SDK's nvd package handles NVD lookups internally -- you do not need to query the NVD API directly.