Get Scan Details by ID
We have introduced the get scan details API to get the scan details. This API allows you to retrieve scan details using its identifier, returning record details.
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 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>/tai/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>/tai/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>/tai/api/1.0/scan/9221350?fields=id%2Cname%2Cstatus%2Coptionprofile.id%2Cscanner
-H 'accept: application/json' \
API Response:
{
"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"
}
}