TotalAI Release 1.6.1 API
November 25, 2025
Before understanding the API release highlights, learn more about the API server URL to be used in your API requests by referring to the Know Your Qualys API Server URL section. For these API Release Notes, <qualys_base_url> is mentioned in the sample API requests.
New API: Launch New Scan
| New or Updated API | New |
| API Endpoint | /ta/api/1.0/scan/launch |
| Method | POST |
| DTD or XSD changes | Not Applicable |
We have introduced the launch scan API to launch a new scan. The scan ID will be returned in the response.
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>/ta/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>/ta/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>/ta/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"
}
}
New API: Get Scan Details by ID
| New or Updated API | New |
| API Endpoint | /ta/api/1.0/scan/{id} |
| Method | GET |
| DTD or XSD changes | Not Applicable |
This API allows you to retrieve scan details using its identifier, returning record details.
Input ParametersInput Parameters
You can use the following input parameters to retrieve scan details.
| Parameter | Data Type | Optional/ Mandatory | Description |
|---|---|---|---|
|
id |
Integer |
Mandatory |
Use this parameter to specify the scan ID. |
|
fields |
String |
Optional |
Use this parameter to provide a comma-separated list of fields to display ID, name, status, and so on. |
Sample: Get Scan Details (Internal Scanner)Sample: Get Scan Details (Internal Scanner)
API Request:
curl -X 'GET' \
'<qualys_base_url>/ta/api/1.0/scan/9221350' \
-H 'accept: application/json' \
API Response:
{
"id": 9221350,
"name": "Scan Again - 1.6.1.0-AWS _internal scanner -Fire attack",
"status": "FINISHED",
"scanDate": 1761732794000,
"scanReference": "tai/1761732794473.9458669.1",
"targetModel": {
"id": 80943916,
"name": "1.6.1.0-AWS Bedrock"
},
"optionProfile": {
"id": 7730964,
"name": "Fire attack OP"
},
"scanner": {
"id": 61636497,
"name": "test64bit_LLM"
}
}
Sample: Get Scan Details (External Scanner) Sample: Get Scan Details (External Scanner)
API Request:
curl -X 'GET' \
'<qualys_base_url>/ta/api/1.0/scan/9173754' \
-H 'accept: application/json' \
API Response:
{
"id": 9173754,
"name": "Amazon - External 2025-10-13 13:13:29.682",
"status": "FINISHED",
"scanDate": 1760341449000,
"scanReference": "tai/1760341449455.9449002.1",
"targetModel": {
"id": 79375466,
"name": "Automation-External-AWS Bedrock - 2025-10-13 13:12:30.936"
},
"optionProfile": {
"id": 7565927,
"name": "Do Not Delete - OP"
}
}
Sample: Get Scan Details for the specified fieldsSample: Get Scan Details for the specified fields
API Request:
curl -X 'GET' \
'<qualys_base_url>/ta/api/1.0/scan/9221350?fields=id%2Cname%2Cstatus%2Coptionprofile.id%2Cscanner
-H 'accept: application/json' \
API Response (200 OK):
{
"id": 9221350,
"name": "Scan Again - 1.6.1.0-AWS _internal scanner -Fire attack",
"status": "FINISHED",
"scanDate": 1761732794000,
"optionProfile": {
"id": 7730964
},
"scanner": {
"id": 61636497,
"name": "test64bit_LLM"
}
}