Launch New Scan
We have introduced the launch scan API to launch a new scan. The scan ID will be returned in the response.
All the newly introduced Activation Key APIs can be accessed only with the Qualys Gateway URLs. To learn more about using the API Gateway URL, refer API URLs section at Identify your Qualys Platform.
Input ParametersInput Parameters
You can use the following input parameters to launch the scan.
| Parameter | Data Type | Optional/ Mandatory | Description |
|---|---|---|---|
|
name |
String |
Mandatory |
Use this parameter to define the name of the scan. |
|
targetModelId |
Integer |
Mandatory |
Use this parameter to provide the ID of the target model that you want to scan. |
|
optionProfileId |
Integer |
Optional |
Use this parameter to specify the ID of the option profile that defines scan settings. |
|
scannerType |
String |
Optional |
Use this parameter to select the type of scanner to be used for the scan. |
|
selectedScannerAppliance |
Integer |
Optional |
Use this parameter to specify the ID of the scanner appliance if the scanner type is INTERNAL. |
|
selectedScannerTags |
Integer |
Optional |
Use this parameter to provide the tag IDs associated with the scanner appliance. |
Sample: Launch Scan using Default Option Profile and Scanner TypeSample: Launch Scan using Default Option Profile and Scanner Type
API Request:
curl -X 'POST' \
'<qualys_base_url>/tai/api/1.0/scan/launch' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"name": "Scan - Verify with mandatory fields only",
"targetModelId": 80791371
}'
API Response:
{
"id": 9173960,
"name": "Scan Verify with mandatory fields only",
"status": "NEW",
"scanReference": "tai/1761544519373.9457610.1",
"targetModel": {
"id": 80791371,
"name": "Test API - AWS - External - NJ"
},
"optionProfile": {
"id": 7868365,
"name": "Scan API Test Default - OP"
}
}
Sample: Launch Scan with Defined Option Profile and External Scanner Sample: Launch Scan with Defined Option Profile and External Scanner
API Request:
curl -X 'POST' \
'<qualys_base_url>/tai/api/1.0/scan/launch' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"name": "Scan - API - Change in OP & Scanner type",
"targetModelId": 80791371,
"optionProfileId": 7868565,
"scannerType": "EXTERNAL"
}'
API Response:
{
"id": 9173557,
"name": "Scan - API - Change in OP & Scanner type",
"status": "NEW",
"scanReference": "tai/1761546970760.9457805.1",
"targetModel": {
"id": 80791371,
"name": "Test API - AWS - External - NJ"
},
"optionProfile": {
"id": 7868565,
"name": "Scan API Test Force Change - OP - AJP"
}
}
Sample: Launch Scan with Internal ScannerSample: Launch Scan with Internal Scanner
API Request:
curl -X 'POST' \
'<qualys_base_url>/tai/api/1.0/scan/launch' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"name": "Scan - API - Change scanner type",
"targetModelId": 80791371,
"scannerType": "INTERNAL",
"selectedScannerAppliance": 61636497
}'
API Response:
{
"id": 9173962,
"name": "Scan - API - Change scanner type",
"status": "NEW",
"scanReference": "tai/1761547877415.9458081.1",
"targetModel": {
"id": 80791371,
"name": "Test API - AWS - External - NJ"
},
"optionProfile": {
"id": 7868365,
"name": "Scan API Test Default - OP"
},
"scanner": {
"id": 61636497,
"name": "test64bit_LLM"
}
}
Sample: Launch Scan with using the Scanner with selected tagsSample: Launch Scan with using the Scanner with selected tags
API Request:
curl -X 'POST' \
'<qualys_base_url>/tai/api/1.0/scan/launch' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"name": "API - Scanner Pool Single tag (Override) and OP (No override)",
"targetModelId": 81146985,
"selectedScannerTags": [
{
"id": 146114424
}
]
}
API Response:
{
"id": 9222360,
"name": "API - Scanner Pool Single tag (Override) and OP (No override)",
"status": "SUBMITTED",
"scanDate": 1762329631000,
"scanReference": "tai/1762329631303.9464113.1",
"targetModel": {
"id": 81146985,
"name": "NJ - Test - API - Databricks - External"
},
"optionProfile": {
"id": 7868365,
"name": "Scan API Test Default - OP"
},
"scannerTags": [
{
"name": "NJ Tag"
}
]
}