Container Security Release 1.46 API
November 02, 2026
Before you review the API release highlights, learn more about the API server URL to use in your API requests by referring to the Know Your Qualys API Server URL section. These API release notes use <qualys_base_url> in the sample API requests.
This release extends Container Security to code assets by adding tagging and CI/CD policy support, providing an option to filter SCA vulnerabilities from the code and vulnerability lists, introducing new APIs to create and manage Container Runtime Security (CRS) rules and policies, and providing new Image Compliance and Container Compliance report templates.
Container Security 1.46 includes the following enhancements to the CS APIs.
- Filter SCA Vulnerabilities in the Code and Vulnerability Lists
- Tagging Support for Code Assets
- Policy Support for Code Assets
- Create and Manage Container Runtime Security Rules and Policies
- New Image and Container Compliance Report Templates
Filter SCA Vulnerabilities in the Code and Vulnerability Lists
You can now choose whether the code and vulnerability lists include Software Composition Analysis (SCA) vulnerabilities. Use the new includeScaVuln query parameter to include or exclude SCA vulnerabilities in the API response. By default, the response includes SCA vulnerabilities. To exclude them, set includeScaVuln to false.
The following APIs support the new includeScaVuln query parameter.
- Fetch a List of Vulnerabilities in Your Account
GET /csapi/v1.3/vulnerability - Fetch a List of Code Repository Scan
GET /csapi/v1.3/code - Fetch Details of a Code Repository Scan
GET /csapi/v1.3/code/{uuid}
Updated API: Fetch a List of Vulnerabilities in Your Account
| New or Updated APIs | Updated |
|---|---|
| API Endpoint (New version) | /csapi/v1.3/vulnerability |
| Method | GET |
| DTD XSD Changes | No |
Input ParametersInput Parameters
| Parameter | Mandatory/Optional | Data Type | Description |
|---|---|---|---|
| includeScaVuln | Optional | boolean | Specify whether the response includes SCA vulnerabilities.
|
Sample: Fetch a List of Vulnerabilities in Your AccountSample: Fetch a List of Vulnerabilities in Your Account
API Request
curl -X 'GET' \ '<qualys_base_url>/csapi/v1.3/vulnerability?filter=threatIntel.wormable%3A%60true%60&pageNumber=1&pageSize=50&sort=created%3Adesc&includeScaVuln=false' \ -H 'accept: application/json' \ -H 'Authorization: Bearer <token>'
API Response
{
"data": [
{
"uuid": "d846747a-47b3-3769-b90b-2ef529741ed0",
"assetId": "9615c354-5cdf-34d0-b887-9208ed51f6bc",
"qid": 199941,
"title": "Ubuntu Security Notification for nghttp2 Vulnerability (USN-6505-1)",
"firstFound": 1791655535697,
"lastFound": 1791655535697,
"patchAvailable": true,
"isRogue": false,
"layerSha": [
"f3a12c51479f5537613108d441e6a91040c420d2abe9cf80c0c310fc03a0a7c9"
],
"isExcluded": false,
"host": [
{
"sensorUuid": "ea67e673-1f89-4965-95b2-a44f2cc288d8",
"uuid": "b8ed725d-878e-4e06-a3c8-16f12e2d0b3c",
"hostname": "ip-10-82-10-128",
"ipAddress": "10.82.10.128",
"ipV6Address": "",
"lastUpdated": null
}
],
"software": [
{
"name": "libnghttp2-14:amd64",
"version": "1.43.0-1build3",
"fixVersion": "1.43.0-1ubuntu0.1",
"scanType": "DYNAMIC",
"softwareQlp": "libnghttp2-14:amd64(1.43.0-1build3)"
}
],
"status": null,
"isInherited": false,
"assignedTags": [],
"lastScanned": 1791655536618,
"imageQlp": [
"sha://372ab2caee91bfee30c559a426317fcfc6d9490a852bf3ee8ea011ab5b4c0118",
"digest://art-hq.intranet.qualys.com:5001/qualysdockerhub/dj_repo/3ad15a2942b14f600a987d180dbe0e421791fcd9d4a2400e7d033cfd587b2394",
"reg://art-hq.intranet.qualys.com:5001/qualysdockerhub/dj_repo/image_by_date"
],
"containerQlp": null,
"containerQlpCount": 0,
"baseImage": "2c872498a269a89d8eeb7856d1663abb8de0c9974456467d11cfbb84e030ebe2",
"sha": "372ab2caee91bfee30c559a426317fcfc6d9490a852bf3ee8ea011ab5b4c0118",
"containerSha": null,
"qdsScore": 95,
"riskScore": 238,
"lastUsedDate": null,
"qdsSeverity": "CRITICAL",
"repo": [
{
"registry": "art-hq.intranet.qualys.com:5001",
"repository": "qualysdockerhub/dj_repo",
"tag": "image_by_date",
"registryUuid": "53772e6c-1e31-4cd3-8649-a8b56d3ae444"
}
],
"registryUuid": [
"53772e6c-1e31-4cd3-8649-a8b56d3ae444"
],
"created": 1791655541496,
"updated": 1791655543117
},
{
"uuid": "ed6a4eb2-256f-3e83-b280-3e5608c447e4",
"assetId": "9615c354-5cdf-34d0-b887-9208ed51f6bc",
"qid": 6022248,
"title": "Ubuntu Security Notification for Git Vulnerabilities (USN-7626-1)",
"firstFound": 1791655535987,
"lastFound": 1791655535987,
"patchAvailable": true,
"isRogue": false,
"layerSha": [
"3bab177eb18412070815280e838cea70efa951a09b8ebf7d8ff4ea7c53950083"
],
"isExcluded": false,
"host": [
{
"sensorUuid": "ea67e673-1f89-4965-95b2-a44f2cc288d8",
"uuid": "b8ed725d-878e-4e06-a3c8-16f12e2d0b3c",
"hostname": "ip-10-82-10-128",
"ipAddress": "10.82.10.128",
"ipV6Address": "",
"lastUpdated": null
}
],
"software": [
{
"name": "git",
"version": "1:2.34.1-1ubuntu1.8",
"fixVersion": "1:2.34.1-1ubuntu1.13",
"scanType": "DYNAMIC",
"softwareQlp": "git(1:2.34.1-1ubuntu1.8)"
},
{
"name": "git-man",
"version": "1:2.34.1-1ubuntu1.8",
"fixVersion": "1:2.34.1-1ubuntu1.13",
"scanType": "DYNAMIC",
"softwareQlp": "git-man(1:2.34.1-1ubuntu1.8)"
}
],
"status": null,
"isInherited": false,
"assignedTags": [],
"lastScanned": 1791655536618,
"imageQlp": [
"sha://372ab2caee91bfee30c559a426317fcfc6d9490a852bf3ee8ea011ab5b4c0118",
"digest://art-hq.intranet.qualys.com:5001/qualysdockerhub/dj_repo/3ad15a2942b14f600a987d180dbe0e421791fcd9d4a2400e7d033cfd587b2394",
"reg://art-hq.intranet.qualys.com:5001/qualysdockerhub/dj_repo/image_by_date"
],
"containerQlp": null,
"containerQlpCount": 0,
"baseImage": "2c872498a269a89d8eeb7856d1663abb8de0c9974456467d11cfbb84e030ebe2",
"sha": "372ab2caee91bfee30c559a426317fcfc6d9490a852bf3ee8ea011ab5b4c0118",
"containerSha": null,
"qdsScore": 95,
"riskScore": 238,
"lastUsedDate": null,
"qdsSeverity": "CRITICAL",
"repo": [
{
"registry": "art-hq.intranet.qualys.com:5001",
"repository": "qualysdockerhub/dj_repo",
"tag": "image_by_date",
"registryUuid": "53772e6c-1e31-4cd3-8649-a8b56d3ae444"
}
],
"registryUuid": [
"53772e6c-1e31-4cd3-8649-a8b56d3ae444"
],
"created": 1791655540617,
"updated": 1791655543117
}
],
"count": 2,
"groups": {},
"aggs": null
}
Updated API: Fetch a List of Code Repository Scan
| New or Updated APIs | Updated |
|---|---|
| API Endpoint (New version) | /csapi/v1.3/code |
| Method | GET |
| DTD XSD Changes | No |
Input ParametersInput Parameters
| Parameter | Mandatory/Optional | Data Type | Description |
|---|---|---|---|
| includeScaVuln | Optional | boolean | Specify whether the response includes SCA vulnerabilities.
|
Sample: Fetch a List of Code Repository ScanSample: Fetch a List of Code Repository Scan
API Request
curl -X 'GET' \ '<qualys_base_url>/csapi/v1.3/code?filter=controls.posture%3A%20FAIL&pageNumber=1&pageSize=50&sort=created%3Adesc&includeScaVuln=true' \ -H 'accept: application/json' \ -H 'Authorization: Bearer <token>'
API Response
{
"data": [
{
"uuid": "62405071-7343-3be5-a329-117780b1c985",
"codeId": "ec7ede65426042db3cd04983d4350d187d2298f1a0a7a199f82b5667753a8fed",
"repositoryUrl": "https://oauth2:[email protected]/surkadam/qscanner-demo.git",
"repositoryName": "qscanner-demo",
"branch": "master",
"commitHash": "afe593744dc6957dbd70662afa0d982d826acd7c",
"commitTimestamp": "1791348657000",
"commitAuthor": "qscanner Demo",
"created": "1791348689269",
"updated": "1791437135480",
"lastScanned": "1791348688887",
"softwareCount": 22,
"vulnerabilityCount": 228,
"vulnerabilityStats": {
"severity5Count": 35,
"severity4Count": 89,
"severity3Count": 82,
"severity2Count": 22,
"severity1Count": 0
},
"riskScore": 224,
"maxQdsScore": 95,
"qdsSeverity": "CRITICAL",
"lastComplianceScanned": "1791348695891",
"assignedTags": [
{
"uuid": "87e8f688-4b1c-4efa-970e-22efc8528ad5",
"id": 144576571,
"name": "ron_policy_deny",
"criticalityScore": 0,
"backgroundColor": "#000000",
"foregroundColor": "#000000",
"icon": "",
"tagType": "MANUAL"
},
{
"uuid": "ad985e00-f52d-409d-a6fd-c356df310199",
"id": 144762203,
"name": "ron_test01",
"criticalityScore": 0,
"backgroundColor": "#000000",
"foregroundColor": "#000000",
"icon": "",
"tagType": "MANUAL"
},
{
"uuid": "309c9ec2-03e8-4701-9e55-424de0fd7367",
"id": 143325039,
"name": "art-hq",
"criticalityScore": 0,
"backgroundColor": "#000000",
"foregroundColor": "#000000",
"icon": "",
"tagType": "CASCADE_PARENT"
},
{
"uuid": "7afac116-271b-468c-9966-60ea0620249b",
"id": 144658429,
"name": "soft_02",
"criticalityScore": 0,
"backgroundColor": "#000000",
"foregroundColor": "#000000",
"icon": "",
"tagType": "MANUAL"
},
{
"uuid": "147658af-8ea3-487e-8299-b8896df30e8c",
"id": 141831342,
"name": "Abc_Test",
"criticalityScore": 0,
"backgroundColor": "#000000",
"foregroundColor": "#000000",
"icon": "",
"tagType": "CASCADE_PARENT"
}
],
"lastUsedDate": null,
"compliance": {
"failCount": 13,
"passCount": 33,
"skipCount": 54,
"errorCount": 54
}
}
],
"count": 1
}
Updated API: Fetch Details of a Code Repository Scan
| New or Updated APIs | Updated |
|---|---|
| API Endpoint (New version) | /csapi/v1.3/code/{uuid} |
| Method | GET |
| DTD XSD Changes | No |
Input ParametersInput Parameters
| Parameter | Mandatory/Optional | Data Type | Description |
|---|---|---|---|
| includeScaVuln | Optional | boolean | Specify whether the response includes SCA vulnerabilities.
|
Sample: Fetch Details of a Code Repository ScanSample: Fetch Details of a Code Repository Scan
API Request
curl -X 'GET' \ '<qualys_base_url>/csapi/v1.3/code/62405071-7343-3be5-a329-117780b1c985?includeScaVuln=true' \ -H 'accept: application/json' \ -H 'Authorization: Bearer <token>'
API Response (Truncated)
{
"details": {
"uuid": "62405071-7343-3be5-a329-117780b1c985",
"codeId": "ec7ede65426042db3cd04983d4350d187d2298f1a0a7a199f82b5667753a8fed",
"repositoryUrl": "https://[REDACTED]@gitlab.com/test/qscanner-demo.git",
"repositoryName": "qscanner-demo",
"branch": "master",
"commitHash": "afe593744dc6957dbd70662afa0d982d826acd7c",
"commitTimestamp": "1791348657000",
"commitAuthor": "qscanner Demo",
"commitMessage": "Add AI app code aligned to qscanner 5.3.0 compliance controls\n\nGood/bad assistant implementations, M…",
"created": "1791348689269",
"updated": "1791437135480",
"lastScanned": "1791348688887",
"lastComplianceScanned": "1791348695891",
"firstFound": "1791348689269",
"assetName": "./scan-target",
"isModified": false,
"lastUsedDate": null,
"scanTypes": ["SCA"],
"source": ["COMMAND_LINE"],
"softwareCount": 22,
"vulnerabilityCount": 228,
"vulnerabilityStats": {
"severity5Count": 35, "severity4Count": 89, "severity3Count": 82,
"severity2Count": 22, "severity1Count": 0
},
"riskScore": 224,
"maxQdsScore": 95,
"qdsSeverity": "CRITICAL",
"formulaUsed": "MIN (1000 , 2 * ( 1.0 * 60.20 * Pow(35,0.01) + 0.6 * 45.16 * Pow(88,0.01) + 0.4 * 36.63 * Pow(80,0.0…",
"assignedTags": [
{
"uuid": "309c9ec2-03e8-4701-9e55-424de0fd7367",
"id": 143325039,
"name": "art-hq",
"tagType": "CASCADE_PARENT",
"criticalityScore": 0,
"backgroundColor": "#000000",
"foregroundColor": "#000000",
"icon": ""
},
"... 4 more items (total 5)"
],
"vulnerabilities": [
{
"qid": 995283,
"title": "Python (Pip) Security Update for django (GHSA-6c3j-c64m-qhgq)",
"category": "SCA",
"typeDetected": "CONFIRMED",
"severity": 3,
"customerSeverity": 3,
"qdsScore": 95,
"risk": 30,
"patchAvailable": true,
"firstFound": "1791348688553",
"lastFound": "1791348688553",
"published": 1695048459000,
"cveids": ["... 1 item"],
"cvssInfo": "{3 keys}",
"cvss3Info": "{2 keys}",
"threatIntel": "{21 keys}",
"software": ["... 1 item"],
"supportedBy": ["... 5 items"],
"vendor": ["... 1 item"],
"product": ["... 1 item"]
},
"... 227 more items (total 228)"
],
"software": [
{
"name": "Jinja2",
"packagePath": "apps/python-app/requirements.txt",
"scanType": "SCA",
"vulnerabilities": ["... 5 items"]
},
"... 21 more items (total 22)"
],
"metadata": null
},
"complianceSummary": {
"failCount": 13, "passCount": 33, "skipCount": 54, "errorCount": 54
},
"vulnSummary": {
"confirmed": { "sev1Count": 0, "sev2Count": 19, "sev3Count": 69, "sev4Count": 60, "sev5Count": 15 },
"potential": { "sev1Count": 0, "sev2Count": 0, "sev3Count": 0, "sev4Count": 0, "sev5Count": 0 },
"igs": { "sev1Count": 0, "sev2Count": 3, "sev3Count": 13, "sev4Count": 29, "sev5Count": 20 },
"patchAvailability": {
"confirmed": { "sev1Count": 0, "sev2Count": 16, "sev3Count": 68, "sev4Count": 59, "sev5Count": 14 },
"potential": { "sev1Count": 0, "sev2Count": 0, "sev3Count": 0, "sev4Count": 0, "sev5Count": 0 },
"igs": { "sev1Count": 0, "sev2Count": 3, "sev3Count": 11, "sev4Count": 21, "sev5Count": 20 }
}
}
}
Tagging Support for Code Assets
You can also cascade a tag assigned to a code asset to the images associated with the asset. The tagging APIs now accept CODE as an entity type. The following APIs are updated to support this feature.
- Assign Tags to an Asset
POST /csapi/v1.3/tag/assign - Assign Multiple Tags to Multiple Assets
POST /csapi/v1.3/tag/assign/bulk - Remove Tags Assigned to Assets
POST /csapi/v1.3/tag/remove - Fetch a List of Code Repository Scans
GET /csapi/v1.3/code - Fetch Details of a Code Repository Scan
GET /csapi/v1.3/code/{uuid} - Fetch a List of Code Repository Scans in Bulk
GET /csapi/v1.3/code/list
Updated API: Assign Tags to an Asset
| New or Updated APIs | Updated |
|---|---|
| API Endpoint (New version) | /csapi/v1.3/tag/assign |
| Method | POST |
| DTD XSD Changes | No |
Input ParametersInput Parameters
The following parameters are new or updated.
| Parameter | Mandatory/Optional | Data Type | Description |
|---|---|---|---|
| entityType | Mandatory | string | Specify the type of entity to which you want to assign a tag. Valid values: IMAGE, CONTAINER, or CODE. |
| isCascadeToImage | Optional | boolean | Specify whether to apply a code asset tag to the images that are associated with the code asset. This parameter is part of tagsToAdd. Valid values:
|
Sample: Assign a Tag to a Code AssetSample: Assign a Tag to a Code Asset
API Request
curl -X 'POST' \
'<qualys_base_url>/csapi/v1.3/tag/assign' \
-H 'accept: application/json' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{
"entityUuid": "798f29bf-c188-4fa2-b559-41e9dafb7512",
"entityType": "CODE",
"moduleCode": "CS",
"tagsToAdd": [
{
"tagName": "test082026",
"isCascadeToImage": false
}
]
}'
API Response
{
"entityUUID": "53xx53-2472-3727-8397-3163xxxcb",
"cascadingKafkaJobUuid": "dfb4c607-e549-4bc9-8652-a15299e27111"
}
Updated API: Assign Multiple Tags to Multiple Assets
| New or Updated APIs | Updated |
|---|---|
| API Endpoint (New version) | /csapi/v1.3/tag/assign/bulk |
| Method | POST |
| DTD XSD Changes | No |
Input ParametersInput Parameters
The following parameters are new or updated.
| Parameter | Mandatory/Optional | Data Type | Description |
|---|---|---|---|
| entityType | Mandatory | string | Specify the type of entity to which you want to assign a tag. Valid values: IMAGE, CONTAINER, or CODE. |
| isCascadeToImage | Optional | boolean | Specify whether to apply a code asset tag to the images that are associated with the code asset. This parameter is part of tagsToAdd.
Valid values:
|
Sample: Assign Multiple Tags to Multiple ContainersSample: Assign Multiple Tags to Multiple Containers
API Request
curl -X 'POST' \ '<qualys_base_url>/csapi/v1.3/tag/assign/bulk' \ -H 'accept: application/json' \ -H Authorization: Bearer <Token> \ -H 'Content-Type: application/json' \ -d "{ "entityUUIDs": [ "138bc6cd-e2b5-347d-bb7d-80884236b1ac", "9e80fb7c-162d-3e50-a343-b132dab205fd" ], "tagsToAdd": [ { "tagUuid": "059d4a45-34df-43af-b0a4-003a5306142c", "isCascadeToContainer": false,"isCascadeToImage": false}, { "tagUuid": "2f6ee932-26eb-4da6-b053-554016bc8feb", "isCascadeToContainer": false } ], "subscriptionId": "44****9", "entityType": "CODE", "moduleCode": "CS" }"
Response
{
"assignmentJobId": "b0xxxa4-c8d7-461a-b952-94f2xxx8c",
"cascadeJobUuids": []
}
Updated API: Remove Tags Assigned to Assets
| New or Updated APIs | Updated |
|---|---|
| API Endpoint (New version) | /csapi/v1.3/tag/remove |
| Method | POST |
| DTD XSD Changes | No |
Input ParametersInput Parameters
The following parameter is updated.
| Parameter | Mandatory/Optional | Data Type | Description |
|---|---|---|---|
| entityType | Mandatory | string | Specify the type of entity from which you want to remove a tag. Valid values: IMAGE, CONTAINER, or CODE. |
| isCascadeToImage | Optional | boolean | Specify whether to remove the code asset tag from the images associated with the code asset.
Valid values:
|
Sample: Remove Tags from a Code AssetSample: Remove Tags from a Code Asset
API Request
curl -X 'POST'
'<qualys_base_url>/csapi/v1.3/tag/remove'
-H 'accept: application/json'
-H Authorization: Bearer <Token>
-H 'Content-Type: application/json'
-d ’{
"entityUUID": "3473dbda-8c77-38ee-aa0d-639cfba4374f",
"tagsToAdd": [
{
"isCascadeToImage": false },
]
"tagsToRemove": [
"2f6ee932-26eb-4da6-b053-554016bc8feb",
"53f5dd37-2ee6-4be1-8800-8392ab3260ff"
],
"subscriptionId": "44***09",
"entityType": "CODE",
"moduleCode": "CS"
}
Response
{
"entityUUID": "3473xxxxa-8c77-38ee-aa0d-639xxx4f"
}
Updated API: Fetch a List of Code Repository Scans
| New or Updated APIs | Updated |
|---|---|
| API Endpoint (New version) | /csapi/v1.3/code |
| Method | GET |
| DTD XSD Changes | No |
Input ParametersInput Parameters
| Parameter | Mandatory/Optional | Data Type | Description |
|---|---|---|---|
| lastUsedDate | Optional | long | Date and time when the code asset was last used. |
Sample: Fetch a List of Code Repository ScansSample: Fetch a List of Code Repository Scans
API Request
curl -X 'GET' \ '<qualys_base_url>/csapi/v1.3/code?pageNumber=1&pageSize=50&sort=created%3Adesc' \ -H 'accept: application/json' \ -H 'Authorization: Bearer <token>'
API Response (Truncated)
{
"data": [
{
"uuid": "62405071-7343-3be5-a329-117780b1c985",
"codeId": "ec7ede65426042db3cd04983d4350d187d2298f1a0a7a199f82b5667753a8fed",
"repositoryUrl": "https://[REDACTED]@gitlab.com/test/qscanner-demo.git",
"repositoryName": "qscanner-demo",
"branch": "master",
"commitHash": "afe593744dc6957dbd70662afa0d982d826acd7c",
"commitTimestamp": "1791348657000",
"commitAuthor": "qscanner Demo",
"created": "1791348689269",
"updated": "1791437135480",
"lastScanned": "1791348688887",
"softwareCount": 22,
"vulnerabilityCount": 228,
"vulnerabilityStats": {
"severity5Count": 35,
"severity4Count": 89,
"severity3Count": 82,
"severity2Count": 22,
"severity1Count": 0
},
"riskScore": 224,
"maxQdsScore": 95,
"qdsSeverity": "CRITICAL",
"lastComplianceScanned": "1791348695891",
"assignedTags": [
{
"uuid": "309c9ec2-03e8-4701-9e55-424de0fd7367",
"id": 143325039,
"name": "art-hq",
"criticalityScore": 0,
"backgroundColor": "#000000",
"foregroundColor": "#000000",
"icon": "",
"tagType": "CASCADE_PARENT"
},
"... 4 more items (total 5)"
],
"lastUsedDate": null,
"compliance": {
"failCount": 13,
"passCount": 33,
"skipCount": 54,
"errorCount": 54
}
}
],
"count": 1
}
Updated API: Fetch Details of a Code Repository Scan
| New or Updated APIs | Updated |
|---|---|
| API Endpoint (New version) | /csapi/v1.3/code/{uuid} |
| Method | GET |
| DTD XSD Changes | No |
Input ParametersInput Parameters
| Parameter | Mandatory/Optional | Data Type | Description |
|---|---|---|---|
| lastUsedDate | Optional | long | Date and time when the code asset was last used. |
Sample: Fetch Details of a Code Repository ScanSample: Fetch Details of a Code Repository Scan
API Request
curl -X 'GET' \ '<qualys_base_url>/csapi/v1.3/code/62405071-7343-3be5-a329-117780b1c985' \ -H 'accept: application/json' \ -H 'Authorization: Bearer <token>'
API Response
{
"details": {
"uuid": "429c1ae4-1ddb-307e-bcb3-05aa9xxxxbc7",
"codeId": "57f185787dc0f8136ee0c6bbcfexxxxe06fbf779a54a4a826xxx760f1",
"repositoryUrl": "https://xxxb.com/run-llama/llama_xxxex.git",
"repositoryName": "llama_index",
"branch": "main",
"commitHash": "9aa5ee5cd2a1ecff6ffa2a8cd6af46b87af674b9",
"commitTimestamp": "1780091579000",
"commitAuthor": "Nhat Minh",
"created": "1780495186664",
"updated": "1780495186664",
"lastScanned": null,
"lastUsedDate": null,
"softwareCount": null,
"vulnerabilityCount": null,
"vulnerabilityStats": null,
"riskScore": null,
"maxQdsScore": null,
"qdsSeverity": null,
"lastComplianceScanDate": "1780495186664",
"assetName": "https://xxx.com/run-llama/llama_index.git",
"isModified": false,
"commitMessage": "perf: use a set instead of a list for within-batch dedup in Ingestion… (#21755)",
"commitAuthorEmail": "[email protected]",
"firstFound": "1780495186664",
"source": [
"COMMAND_LINE"
],
"scanTypes": [
"SCA"
],
"vulnerabilities": null,
"software": null,
"metadata": null,
"formulaUsed": null,
"riskScoreCalculatedDate": null
},
"vulnSummary": {
"confirmed": {
"sev1Count": 0,
"sev5Count": 0,
"sev2Count": 0,
"sev4Count": 0,
"sev3Count": 0
},
"potential": {
"sev1Count": 0,
"sev5Count": 0,
"sev2Count": 0,
"sev4Count": 0,
"sev3Count": 0
},
"igs": {
"sev1Count": 0,
"sev5Count": 0,
"sev2Count": 0,
"sev4Count": 0,
"sev3Count": 0
},
"patchAvailability": {
"confirmed": {
"sev1Count": 0,
"sev5Count": 0,
"sev2Count": 0,
"sev4Count": 0,
"sev3Count": 0
},
"potential": {
"sev1Count": 0,
"sev5Count": 0,
"sev2Count": 0,
"sev4Count": 0,
"sev3Count": 0
},
"igs": {
"sev1Count": 0,
"sev5Count": 0,
"sev2Count": 0,
"sev4Count": 0,
"sev3Count": 0
}
}
},
"complianceSummary": {
"failCount": 28,
"passCount": 37,
"skipCount": 32,
"errorCount": 32
}
}
Updated API: Fetch a List of Code Repository Scans in Bulk
| New or Updated APIs | Updated |
|---|---|
| API Endpoint (New version) | /csapi/v1.3/code/list |
| Method | GET |
| DTD XSD Changes | No |
Input ParametersInput Parameters
| Parameter | Mandatory/Optional | Data Type | Description |
|---|---|---|---|
| lastUsedDate | Optional | long | Date and time when the code asset was last used. The value is in Unix time. |
Sample: Fetch a List of Code Repository Scans in BulkSample: Fetch a List of Code Repository Scans in Bulk
API Request
curl -X 'GET' \ '<qualys_base_url>/csapi/v1.3/code/list?limit=2' \ -H 'accept: application/json' \ -H 'Authorization: Bearer <token>'
API Response (Truncated)
{
"data": [
{
"uuid": "62405071-7343-3be5-a329-117780b1c985",
"codeId": "ec7ede65426042db3cd04983d4350d187d2298f1a0a7a199f82b5667753a8fed",
"repositoryUrl": "https://[REDACTED]@gitlab.com/test/qscanner-demo.git",
"repositoryName": "qscanner-demo",
"branch": "master",
"assetName": "./scan-target",
"isModified": false,
"lastUsedDate": null,
"commitHash": "afe593744dc6957dbd70662afa0d982d826acd7c",
"commitTimestamp": "1791348657000",
"commitAuthor": "qscanner Demo",
"commitMessage": "Add AI app code aligned to qscanner 5.3.0 compliance controls\n\nGood/bad assistant implementations, M…",
"created": "1791348689269",
"updated": "1791437135480",
"lastScanned": "1791348688887",
"firstFound": "1791348689269",
"source": ["COMMAND_LINE"],
"scanTypes": ["SCA"],
"softwareCount": 22,
"vulnerabilityCount": 228,
"vulnerabilityStats": {
"severity5Count": 35,
"severity4Count": 89,
"severity3Count": 82,
"severity2Count": 22,
"severity1Count": 0
},
"vulnerabilities": [
{
"qid": 995283,
"title": "Python (Pip) Security Update for django (GHSA-6c3j-c64m-qhgq)",
"category": "SCA",
"typeDetected": "CONFIRMED",
"severity": 3,
"customerSeverity": 3,
"qdsScore": 95,
"risk": 30,
"patchAvailable": true,
"cveids": ["... 1 item"],
"software": ["... 1 item"]
},
"... 227 more items (total 228)"
]
},
"... 1 more item (total 2)"
]
}
Policy Support for Code Assets
You can now create centralized CI/CD policies for code assets and evaluate code scans against them. Similar to image assessment policies, code policies contain rules that determine whether a code scan passes or fails.
This release does not add new APIs. The existing centralized policy APIs now support code assets with the following updates:
- Set policyType to
CICD_CODE. - Set kind of each policy rule to
CODE_SECURITY. - Use the
CODESCAN_VULN_prefix for the type of each policy rule, for example,CODESCAN_VULN_SEVERITYCOUNT.
The following APIs are updated.
- Create a Centralized Policy
POST /csapi/v1.3/centralizedPolicy - List Centralized Policies
GET /csapi/v1.3/centralizedPolicy - Show Details of a Centralized Policy
GET /csapi/v1.3/centralizedPolicy/{policyId} - Update a Centralized Policy
PUT /csapi/v1.3/centralizedPolicy/{policyId} - Delete a Centralized Policy
DELETE /csapi/v1.3/centralizedPolicy/{policyId}
Updated API: Create a Centralized Policy
| New or Updated APIs | Updated |
|---|---|
| API Endpoint (New version) | /csapi/v1.3/centralizedPolicy |
| Method | POST |
| DTD XSD Changes | No |
Input ParametersInput Parameters
The following parameters take new values for code policies.
| Parameter | Mandatory/Optional | Data Type | Description |
|---|---|---|---|
| policyType | Mandatory | string | Specify the type of policy. For a code policy, specify CICD_CODE. |
| kind | Mandatory | string | Specify the kind of policy rule. For a code policy rule, specify CODE_SECURITY. |
| type | Mandatory | string | Specify the type of the policy rule. For a code policy rule, the type starts with CODESCAN_VULN_, for example, CODESCAN_VULN_RESTRICTED_QIDS. |
Sample: Create a Centralized Policy for Code AssetsSample: Create a Centralized Policy for Code Assets
API Request
curl -X 'POST' \
'<qualys_base_url>/csapi/v1.3/centralizedPolicy' \
-H 'accept: application/json' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{
"policyName": "test demo",
"description": "test demo",
"centralizedPolicyRules": [
{
"name": "Limit Vulnerability using Severity",
"type": "CODESCAN_VULN_SEVERITYCOUNT",
"isEnabled": true,
"stopProcessing": false,
"order": 0,
"kind": "CODE_SECURITY",
"metaData": {
"operator": "GREATER_THAN",
"severityLevel": 2,
"threshold": 1
},
"action": "FAIL"
},
{
"name": "Block Known Vulnerability using QIDs",
"type": "CODESCAN_VULN_RESTRICTED_QIDS",
"isEnabled": true,
"stopProcessing": false,
"order": 0,
"kind": "CODE_SECURITY",
"metaData": {
"values": [
"456634"
]
},
"action": "FAIL"
},
{
"name": "Block Known Vulnerability using CVEs",
"type": "CODESCAN_VULN_RESTRICTED_CVES",
"isEnabled": true,
"stopProcessing": false,
"order": 0,
"kind": "CODE_SECURITY",
"metaData": {
"values": [
"CVE-2024-12345"
]
},
"action": "FAIL"
},
{
"name": "Limit Vulnerability using CVSS",
"type": "CODESCAN_VULN_CVSSV3_SEVERITYCOUNT",
"isEnabled": true,
"stopProcessing": false,
"order": 0,
"kind": "CODE_SECURITY",
"metaData": {
"value": "MEDIUM",
"operator": "GREATER_THAN",
"threshold": 1
},
"action": "FAIL"
},
{
"name": "Enforce Qualys Detection Score Threshold",
"type": "CODESCAN_VULN_QDS_SEVERITY",
"isEnabled": true,
"stopProcessing": false,
"order": 0,
"kind": "CODE_SECURITY",
"metaData": {
"value": "LOW"
},
"action": "FAIL"
},
{
"name": "Block Unauthorized Software",
"type": "CODESCAN_VULN_RESTRICTED_SOFTWARES",
"isEnabled": true,
"stopProcessing": false,
"order": 0,
"kind": "CODE_SECURITY",
"metaData": {
"values": [
"testSoftware"
]
},
"action": "FAIL"
},
{
"name": "Block Unauthorized Author",
"type": "CODESCAN_VULN_RESTRICTED_AUTHORS",
"isEnabled": true,
"stopProcessing": false,
"order": 0,
"kind": "CODE_SECURITY",
"metaData": {
"values": [
"quays_sk1"
]
},
"action": "FAIL"
},
{
"name": "Block Older Vulnerability",
"type": "CODESCAN_VULN_RESTRICTED_OLDER_VULNERABILITY",
"isEnabled": true,
"stopProcessing": false,
"order": 0,
"kind": "CODE_SECURITY",
"metaData": {
"value": 30
},
"action": "FAIL"
},
{
"name": "Block Known Compliance Using Controls",
"type": "CODESCAN_VULN_RESTRICTED_CIDS",
"isEnabled": true,
"stopProcessing": false,
"order": 0,
"kind": "CODE_SECURITY",
"metaData": {
"values": [
10826
]
},
"action": "FAIL"
},
{
"name": "Limit Compliance using Criticality",
"type": "CODESCAN_VULN_CONTROL_CRITICALITYCOUNT",
"isEnabled": true,
"stopProcessing": false,
"order": 0,
"kind": "CODE_SECURITY",
"metaData": {
"value": "LOW",
"operator": "GREATER_THAN_OR_EQUAL",
"threshold": 1
},
"action": "FAIL"
}
],
"exclusionPolicyRules": [],
"policyMode": "ACTIVE",
"policyType": "CICD_CODE",
"isDefault": false,
"policyBehavior": "BLOCK",
"tagIds": [
"599e35ee-57a9-4994-8553-e330e3002da2",
"473e4b95-96b1-4919-b9fb-f7b4db0a17a1"
],
"excludedTagIds": [],
"k8sFilters": [],
"excludedK8sFilters": []
}'
API Response
{
"uuid":"a7520de7-efcc-4be4-8b4b-7d5bffbd204c"
}
Updated API: List Centralized Policies
| New or Updated APIs | Updated |
|---|---|
| API Endpoint (New version) | /csapi/v1.3/centralizedPolicy |
| Method | GET |
| DTD XSD Changes | No |
Input ParametersInput Parameters
| Parameter | Mandatory/Optional | Data Type | Description |
|---|---|---|---|
| filter | Optional | string | Filter the policy list by providing a query using Qualys syntax. To list only code policies, specify policyType:CICD_CODE. |
Sample: List Centralized Policies for Code AssetsSample: List Centralized Policies for Code Assets
API Request
curl -X 'GET' \ '<qualys_base_url>/csapi/v1.3/centralizedPolicy?filter=policyType%3ACICD_CODE&pageNumber=1&pageSize=50&sort=created%3Adesc' \ -H 'accept: application/json' \ -H 'Authorization: Bearer <token>'
API Response
{
"data": [
{
"uuid": "6092a3f9-6e3f-4fcb-9a5e-a19530fd3408",
"policyName": "test QA handoff demo",
"description": "test QA handoff demo",
"policyMode": "ACTIVE",
"createdBy": "quays_sk1",
"created": "1787303376682",
"updatedBy": "quays_sk1",
"updated": "1787303376682",
"policyType": "CICD_CODE",
"policyBehavior": "BLOCK",
"isDefault": false,
"assignedTags": [
{
"uuid": "599e35ee-57a9-4994-8553-e330e3002da2",
"id": 7641613,
"name": "test2921",
"backgroundColor": "#000000",
"foregroundColor": "#000000",
"icon": null,
"criticalityScore": 0,
"tagType": null
}
],
"excludedTags": []
},
{
"uuid": "95299d6b-cc8a-400f-a586-600a966ccf2a",
"policyName": "policy with few disabled rules",
"description": "policy with few disabled rules",
"policyMode": "ACTIVE",
"createdBy": "quays_sk1",
"created": "1786690480210",
"updatedBy": "quays_sk1",
"updated": "1787300311677",
"policyType": "CICD_CODE",
"policyBehavior": "BLOCK",
"isDefault": true,
"assignedTags": [],
"excludedTags": [
{
"uuid": "599e35ee-57a9-4994-8553-e330e3002da2",
"id": 7641613,
"name": "test2921",
"backgroundColor": "#000000",
"foregroundColor": "#000000",
"icon": null,
"criticalityScore": 0,
"tagType": null
}
]
},
{
"uuid": "2860a7e5-7c7d-4dbd-81a9-b2fb09997917",
"policyName": "default policy without tag",
"description": "",
"policyMode": "INACTIVE",
"createdBy": "quays_sk1",
"created": "1786689713977",
"updatedBy": "quays_sk1",
"updated": "1786947180716",
"policyType": "CICD_CODE",
"policyBehavior": "BLOCK",
"isDefault": true,
"assignedTags": [],
"excludedTags": []
},
{
"uuid": "412e0eee-156e-46e4-8323-58cc00ad06c9",
"policyName": "policy exclude tag test2921",
"description": "",
"policyMode": "ACTIVE",
"createdBy": "quays_sk1",
"created": "1786689692571",
"updatedBy": "quays_sk1",
"updated": "1787287617484",
"policyType": "CICD_CODE",
"policyBehavior": "BLOCK",
"isDefault": true,
"assignedTags": [],
"excludedTags": [
{
"uuid": "599e35ee-57a9-4994-8553-e330e3002da2",
"id": 7641613,
"name": "test2921",
"backgroundColor": "#000000",
"foregroundColor": "#000000",
"icon": null,
"criticalityScore": 0,
"tagType": null
}
]
},
{
"uuid": "a3387b78-16d9-4012-aca3-078d246e3ca3",
"policyName": "policy tag test2921",
"description": "policy tag test2921",
"policyMode": "ACTIVE",
"createdBy": "quays_sk1",
"created": "1786689622270",
"updatedBy": "quays_sk1",
"updated": "1787111582370",
"policyType": "CICD_CODE",
"policyBehavior": "BLOCK",
"isDefault": false,
"assignedTags": [
{
"uuid": "599e35ee-57a9-4994-8553-e330e3002da2",
"id": 7641613,
"name": "test2921",
"backgroundColor": "#000000",
"foregroundColor": "#000000",
"icon": null,
"criticalityScore": 0,
"tagType": null
}
],
"excludedTags": []
}
],
"count": 5,
"groups": {},
"aggs": null
}
Updated API: Show Details of a Centralized Policy
| New or Updated APIs | Updated |
|---|---|
| API Endpoint (New version) | /csapi/v1.3/centralizedPolicy/{policyId} |
| Method | GET |
| DTD XSD Changes | No |
Input ParametersInput Parameters
The following parameter now accepts a code policy ID.
| Parameter | Mandatory/Optional | Data Type | Description |
|---|---|---|---|
| policyId | Mandatory | string | Specify the UUID of the policy whose details you want to fetch. To fetch the details of a code policy, specify the UUID of a policy whose policyType is CICD_CODE. |
Sample: Show Details of a Centralized Policy for Code AssetsSample: Show Details of a Centralized Policy for Code Assets
API Request
curl -X 'GET' \ '<qualys_base_url>/csapi/v1.3/centralizedPolicy/cf77cade-18ac-4ea9-9086-543243f9b539' \ -H 'accept: application/json' \ -H 'Authorization: Bearer <token>'
API Response
{
"uuid": "a7520de7-efcc-4be4-8b4b-7d5bffbd204c",
"policyName": "test12345",
"policyType": "CICD_CODE",
"policyMode": "ACTIVE",
"policyBehavior": "BLOCK",
"description": "",
"createdBy": "arthxas27",
"created": "1792395136954",
"updatedBy": "arthxas27",
"updated": "1792395199663",
"centralizedPolicyRules": [
{
"name": "Limit Vulnerability using Severity",
"type": "CODESCAN_VULN_SEVERITYCOUNT",
"action": "FAIL",
"isEnabled": true,
"stopProcessing": false,
"sortOrder": 0,
"metaData": "{\"operator\":\"GREATER_THAN\",\"severityLevel\":3,\"threshold\":1}",
"kind": "CODE_SECURITY"
}
],
"exclusionPolicyRules": [],
"version": 2,
"isDefault": false,
"tagIds": [
{
"uuid": "457f8288-0f8c-4618-bbf0-fc65176e2fc6",
"id": 174236469,
"name": "arth",
"backgroundColor": "#000000",
"foregroundColor": "#000000",
"icon": null,
"criticalityScore": 0,
"tagType": null
}
],
"excludedTagIds": null,
"k8sFilters": null,
"excludedK8sFilters": null
}
Updated API: Update a Centralized Policy
| New or Updated APIs | Updated |
|---|---|
| API Endpoint (New version) | /csapi/v1.3/centralizedPolicy/{policyId} |
| Method | PUT |
| DTD XSD Changes | No |
Input ParametersInput Parameters
The following parameters take new values for code policies.
| Parameter | Mandatory/Optional | Data Type | Description |
|---|---|---|---|
| policyType | Mandatory | string | Specify the type of the policy. For a code policy, specify CICD_CODE. |
| kind | Mandatory | string | Specify the kind of the policy rule. For a code policy rule, specify CODE_SECURITY. |
| type | Mandatory | string | Specify the type of the policy rule. For a code policy rule, the type starts with CODESCAN_VULN_, for example, CODESCAN_VULN_RESTRICTED_QIDS. |
Sample: Update a Centralized Policy for Code AssetsSample: Update a Centralized Policy for Code Assets
API Request
curl -X 'PUT' \
'<qualys_base_url>/csapi/v1.3/centralizedPolicy/cf77cade-18ac-4ea9-9086-543243f9b539' \
-H 'accept: application/json' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{
"uuid": "cf77cade-18ac-4ea9-9086-543243f9b539",
"policyName": "test arth",
"policyType": "CICD_CODE",
"policyMode": "ACTIVE",
"policyBehavior": "BLOCK",
"description": "test demo",
"createdBy": "quays_sk1",
"created": "1787288319675",
"updatedBy": "quays_sk1",
"updated": "1787288319675",
"centralizedPolicyRules": [
{
"name": "Limit Vulnerability using CVSS",
"type": "CODESCAN_VULN_CVSSV3_SEVERITYCOUNT",
"action": "FAIL",
"isEnabled": true,
"stopProcessing": false,
"sortOrder": 0,
"metaData": {
"value": "MEDIUM",
"operator": "GREATER_THAN",
"threshold": 1
},
"kind": "CODE_SECURITY"
},
{
"name": "Limit Vulnerability using Severity",
"type": "CODESCAN_VULN_SEVERITYCOUNT",
"action": "FAIL",
"isEnabled": true,
"stopProcessing": false,
"sortOrder": 0,
"metaData": {
"operator": "GREATER_THAN",
"severityLevel": 2,
"threshold": 1
},
"kind": "CODE_SECURITY"
},
{
"name": "Block Older Vulnerability",
"type": "CODESCAN_VULN_RESTRICTED_OLDER_VULNERABILITY",
"action": "FAIL",
"isEnabled": true,
"stopProcessing": false,
"sortOrder": 0,
"metaData": {
"value": 30
},
"kind": "CODE_SECURITY"
},
{
"name": "Enforce Qualys Detection Score Threshold",
"type": "CODESCAN_VULN_QDS_SEVERITY",
"action": "FAIL",
"isEnabled": true,
"stopProcessing": false,
"sortOrder": 0,
"metaData": {
"value": "LOW"
},
"kind": "CODE_SECURITY"
},
{
"name": "Limit Compliance using Criticality",
"type": "CODESCAN_VULN_CONTROL_CRITICALITYCOUNT",
"action": "FAIL",
"isEnabled": true,
"stopProcessing": false,
"sortOrder": 0,
"metaData": {
"value": "LOW",
"operator": "GREATER_THAN_OR_EQUAL",
"threshold": 1
},
"kind": "CODE_SECURITY"
},
{
"name": "Block Known Vulnerability using CVEs",
"type": "CODESCAN_VULN_RESTRICTED_CVES",
"action": "FAIL",
"isEnabled": true,
"stopProcessing": false,
"sortOrder": 0,
"metaData": {
"values": [
"CVE-2024-12345"
]
},
"kind": "CODE_SECURITY"
},
{
"name": "Block Unauthorized Software",
"type": "CODESCAN_VULN_RESTRICTED_SOFTWARES",
"action": "FAIL",
"isEnabled": true,
"stopProcessing": false,
"sortOrder": 0,
"metaData": {
"values": [
"testSoftware"
]
},
"kind": "CODE_SECURITY"
},
{
"name": "Block Known Vulnerability using QIDs",
"type": "CODESCAN_VULN_RESTRICTED_QIDS",
"action": "FAIL",
"isEnabled": true,
"stopProcessing": false,
"sortOrder": 0,
"metaData": {
"values": [
"456634"
]
},
"kind": "CODE_SECURITY"
},
{
"name": "Block Unauthorized Author",
"type": "CODESCAN_VULN_RESTRICTED_AUTHORS",
"action": "FAIL",
"isEnabled": true,
"stopProcessing": false,
"sortOrder": 0,
"metaData": {
"values": [
"quays_sk1"
]
},
"kind": "CODE_SECURITY"
}
],
"exclusionPolicyRules": [
{
"isEnabled": true,
"order": 0,
"sortOrder": 0,
"stopProcessing": false,
"kind": "EXCLUSION",
"action": "FAIL",
"metaData": {
"value": 10
},
"name": "Exclude by Qid Age",
"type": "EX_CODESCAN_VULN_QID_AGE"
},
{
"isEnabled": true,
"order": 0,
"sortOrder": 0,
"stopProcessing": false,
"kind": "EXCLUSION",
"action": "FAIL",
"metaData": {},
"name": "Exclude if patch not available",
"type": "EX_CODESCAN_VULN_PATCH_NOT_AVAILABLE"
},
{
"isEnabled": true,
"order": 0,
"sortOrder": 0,
"stopProcessing": false,
"kind": "EXCLUSION",
"action": "FAIL",
"metaData": {
"values": [
344562
]
},
"name": "Exclude QIDS",
"type": "EX_CODESCAN_VULN_QIDS"
}
],
"version": 1,
"isDefault": false,
"tagIds": [
"599e35ee-57a9-4994-8553-e330e3002da2",
"473e4b95-96b1-4919-b9fb-f7b4db0a17a1"
],
"excludedTagIds": [],
"k8sFilters": [],
"excludedK8sFilters": [],
"hasDeprecatedRulesPresent": false
}'
API Response
{
"uuid":"a7520de7-efcc-4be4-8b4b-7d5bffbd204c"
}'
Updated API: Delete a Centralized Policy
| New or Updated APIs | Updated |
|---|---|
| API Endpoint (New version) | /csapi/v1.3/centralizedPolicy/{policyId} |
| Method | DELETE |
| DTD XSD Changes | No |
Input ParametersInput Parameters
The following parameter now accepts the ID of a code policy.
| Parameter | Mandatory/Optional | Data Type | Description |
|---|---|---|---|
| policyId | Mandatory | string | Specify the UUID of the policy that you want to delete. To delete a code policy, specify the UUID of a policy whose policyType is CICD_CODE. |
Sample: Delete a Centralized Policy for Code AssetsSample: Delete a Centralized Policy for Code Assets
API Request
curl -X 'DELETE' \ '<qualys_base_url>/csapi/v1.3/centralizedPolicy/cf77cade-18ac-4ea9-9086-543243f9b539' \ -H 'accept: application/json' \ -H 'Authorization: Bearer <token>'
API Response
{
"uuid":"a7520de7-efcc-4be4-8b4b-7d5bffbd204c"
}'
Create and Manage Container Runtime Security Rules and Policies
With the new CRS APIs, you can create and manage custom Container Runtime Security (CRS) rules and policies. A rule defines the file or network activity that CRS monitors. A policy applies one or more rules to workloads based on Kubernetes clusters, pod labels, and tags.
CRS Rule APIs
Use the following APIs to create and manage custom CRS rules.
- Create a CRS Rule
POST /csapi/v1.3/crsRule - List CRS Rules
GET /csapi/v1.3/crsRule - Get Details of a CRS Rule
GET /csapi/v1.3/crsRule/{ruleId} - Update a CRS Rule
PUT /csapi/v1.3/crsRule/{ruleId} - Delete a CRS Rule
DELETE /csapi/v1.3/crsRule/{ruleId}
New API: Create a Custom CRS Rule
| New or Updated APIs | New |
|---|---|
| API Endpoint (New version) | /csapi/v1.3/crsRule |
| Method | POST |
| DTD XSD Changes | No |
This API uses the multipart/form-data content type.
Input ParametersInput Parameters
| Parameter | Mandatory/Optional | Data Type | Description |
|---|---|---|---|
| request | Mandatory | JSON object | Specify the rule details as a JSON object. The object includes the following fields:
|
| file | Mandatory | file | Specify the file that defines the rule, for example, read.yml. |
Sample: Create a Custom CRS RuleSample: Create a Custom CRS Rule
API Request
curl -X 'POST' \
'<qualys_base_url>/csapi/v1.3/crsRule' \
-H 'accept: application/json' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: multipart/form-data' \
-F 'request={"ruleName":"check1","ruleDescription":"","ruleType":"file"}' \
-F '[email protected]'
API Response
{
"uuid": "23814c33-e6ee-43ac-aa73-5ad417932e0f"
}
New API: List CRS Rules
| New or Updated APIs | New |
|---|---|
| API Endpoint (New version) | /csapi/v1.3/crsRule |
| Method | GET |
| DTD XSD Changes | No |
Input ParametersInput Parameters
| Parameter | Mandatory/Optional | Data Type | Description |
|---|---|---|---|
| pageNumber | Optional | integer | Specify the page to return. |
| pageSize | Optional | integer | Specify the number of records to return on each page. |
| sort | Optional | string | Sort the results by using a Qualys token. Example: created:desc |
Sample: List CRS RulesSample: List CRS Rules
API Request
curl -X 'GET' \ '<qualys_base_url>/csapi/v1.3/crsRule?pageNumber=1&pageSize=50&sort=created%3Adesc' \ -H 'accept: application/json' \ -H 'Authorization: Bearer <token>'
API Response
{
"data": [
{
"customerUuid": "7cd2ffbb-d2bf-5637-8050-a89cc2ab5402",
"uuid": "23814c33-e6ee-43ac-aa73-5ad417932e0f",
"ruleType": "file",
"ruleCategory": "CUSTOM",
"ruleName": "check1",
"ruleDescription": "",
"createdBy": "arthxas27",
"created": 1791354658106,
"updatedBy": "arthxas27",
"updated": 1791354658106,
"ruleMetadata": {
"severity": "medium",
"fileOperation": "read",
"action": "audit",
"selector": {
"matchFilePaths": {
"values": "/etc/passwd",
"operator": "Prefix"
},
"matchBinaries": {
"values": "/bin/cat",
"operator": "In"
}
}
}
}
],
"count": 4,
"groups": {},
"aggs": null
}
The ruleType field is either file or network.
The rule metadata of a network rule includes selectors such as matchPorts, matchProtocols, matchDNS, matchIPAddresses, matchFQDN, and direction (for example, egress).
New API: Get Details of a CRS Rule
| New or Updated APIs | New |
|---|---|
| API Endpoint (New version) | /csapi/v1.3/crsRule/{ruleId} |
| Method | GET |
| DTD XSD Changes | No |
Input ParametersInput Parameters
| Parameter | Mandatory/Optional | Data Type | Description |
|---|---|---|---|
| ruleId | Mandatory | string | Specify the UUID of the CRS rule. |
Sample: Get Details of a CRS RuleSample: Get Details of a CRS Rule
API Request
curl -X 'GET' \ '<qualys_base_url>/csapi/v1.3/crsRule/23814c33-e6ee-43ac-aa73-5ad417932e0f' \ -H 'accept: application/json' \ -H 'Authorization: Bearer <token>'
API Response
{
"customerUuid": "7cd2ffbb-d2bf-5637-8050-a89cc2ab5402",
"uuid": "23814c33-e6ee-43ac-aa73-5ad417932e0f",
"ruleType": "file",
"ruleCategory": "CUSTOM",
"ruleName": "check1",
"ruleDescription": "",
"createdBy": "arthxas27",
"created": 1791354658106,
"updatedBy": "arthxas27",
"updated": 1791354658106,
"ruleMetadata": "{\"fileOperation\":\"read\",\"action\":\"audit\",\"severity\":\"medium\",\"selector\":{\"matchFilePaths\":{\"operator\":\"Prefix\",\"values\":\"/etc/passwd\"},\"matchBinaries\":{\"operator\":\"In\",\"values\":\"/bin/cat\"}}}"
}
In the response of this API, ruleMetadata is an escaped JSON string. In the response of the List CRS Rules API, ruleMetadata is a nested object.
New API: Update a CRS Rule
| New or Updated APIs | New |
|---|---|
| API Endpoint (New version) | /csapi/v1.3/crsRule/{ruleId} |
| Method | PUT |
| DTD XSD Changes | No |
This API uses the multipart/form-data content type.
Input ParametersInput Parameters
| Parameter | Mandatory/Optional | Data Type | Description |
|---|---|---|---|
| ruleId | Mandatory | string | Specify the UUID of the CRS rule. |
| request | Mandatory | JSON object | Specify the rule details as a JSON object. The object includes the following fields:
|
| file | Mandatory | file | Specify the file that defines the rule, for example, read.yml. |
Sample: Update a CRS RuleSample: Update a CRS Rule
API Request
curl -X 'PUT' \
'<qualys_base_url>/csapi/v1.3/crsRule/23814c33-e6ee-43ac-aa73-5ad417932e0f' \
-H 'accept: application/json' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: multipart/form-data' \
-F 'request={"ruleName":"check234","ruleDescription":"","ruleType":"file"}' \
-F '[email protected]'
API Response
{
"uuid": "23814c33-e6ee-43ac-aa73-5ad417932e0f"
}
New API: Delete a CRS Rule
| New or Updated APIs | New |
|---|---|
| API Endpoint (New version) | /csapi/v1.3/crsRule/{ruleId} |
| Method | DELETE |
| DTD XSD Changes | No |
Input ParametersInput Parameters
| Parameter | Mandatory/Optional | Data Type | Description |
|---|---|---|---|
| ruleId | Mandatory | string | Specify the UUID of the CRS rule. |
Sample: Delete a CRS RuleSample: Delete a CRS Rule
API Request
curl -X 'DELETE' \ '<qualys_base_url>/csapi/v1.3/crsRule/23814c33-e6ee-43ac-aa73-5ad417932e0f' \ -H 'accept: application/json' \ -H 'Authorization: Bearer <token>'
API Response
{
"uuid": "23814c33-e6ee-43ac-aa73-5ad417932e0f"
}
CRS Policy APIs
Use the following APIs to create and manage CRS policies.
- Create a CRS Policy
POST /csapi/v1.3/crsPolicy - Fetch the List of CRS Policies
GET /csapi/v1.3/crsPolicy - Get Details of a CRS Policy
GET /csapi/v1.3/crsPolicy/{policyId} - Update a CRS Policy
PUT /csapi/v1.3/crsPolicy/{policyId} - Delete a CRS Policy
DELETE /csapi/v1.3/crsPolicy/{policyId}
New API: Create a CRS Policy
| New or Updated APIs | New |
|---|---|
| API Endpoint (New version) | /csapi/v1.3/crsPolicy |
| Method | POST |
| DTD XSD Changes | No |
This API uses the application/json content type.
Input ParametersInput Parameters
| Parameter | Mandatory/Optional | Data Type | Description |
|---|---|---|---|
| policyName | Mandatory | string | Specify the name of the policy. |
| policyDescription | Optional | string | Specify a description for the policy. |
| policyMode | Mandatory | boolean | Specify whether the policy is enabled. true enables the policy and false disables it. |
| clustersUuidSet | Mandatory | array of strings | Specify the UUIDs of the clusters to which the policy applies. |
| podLabels | Optional | object (key-value pairs) | Specify the pod labels as key-value pairs. Example: "app": "nginx1" |
| rulesUuidSet | Mandatory | array of strings | Specify the UUIDs of the rules to attach to the policy. |
| tagIds | Optional | array of strings | Specify the UUIDs of the tags. |
Sample: Create a CRS PolicySample: Create a CRS Policy
API Request
curl -X 'POST' \
'<qualys_base_url>/csapi/v1.3/crsPolicy' \
-H 'accept: application/json' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{
"policyName": "test1",
"policyDescription": "",
"policyMode": true,
"clustersUuidSet": [
"7f379df1-a9d5-4e16-b9e2-e5f8cf03dce5"
],
"podLabels": {
"app": "nginx1"
},
"rulesUuidSet": [
"aea38e49-e4a5-43e5-9b7f-0262714b6ac2"
],
"tagIds": [
"457f8288-0f8c-4618-bbf0-fc65176e2fc6"
]
}'
API Response
{
"uuid": "8115f2fd-0ab1-4114-b1b2-d3ce04d5c9b9"
}
New API: Fetch the List of CRS Policies
| New or Updated APIs | New |
|---|---|
| API Endpoint (New version) | /csapi/v1.3/crsPolicy |
| Method | GET |
| DTD XSD Changes | No |
Input ParametersInput Parameters
| Parameter | Mandatory/Optional | Data Type | Description |
|---|---|---|---|
| pageNumber | Optional | integer | Specify the page to return. |
| pageSize | Optional | integer | Specify the number of records to return on each page. |
| sort | Optional | string | Sort the results by using a Qualys token. Example: created:desc |
Sample: Fetch the List CRS PoliciesSample: Fetch the List CRS Policies
API Request
curl -X 'GET' \ '<qualys_base_url>/csapi/v1.3/crsPolicy?pageNumber=1&pageSize=50&sort=created%3Adesc' \ -H 'accept: application/json' \ -H 'Authorization: Bearer <token>'
API Response
{
"data": [
{
"customerUuid": "7cd2ffbb-d2bf-5637-8050-a89cc2ab5402",
"uuid": "b4c99b82-4717-4db3-9bc5-249a0bcfdb36",
"policyName": "read",
"policyDescription": "",
"ownerModule": "CS",
"createdBy": "arthxas27",
"created": 1791351495820,
"updatedBy": "arthxas27",
"updated": 1791351495820,
"policyMode": true,
"version": 1,
"rulesUuidSet": [
"aea38e49-e4a5-43e5-9b7f-0262714b6ac2"
],
"clustersUuidSet": [
"7f379df1-a9d5-4e16-b9e2-e5f8cf03dce5"
],
"podLabels": [],
"tagIds": []
}
],
"count": 1,
"groups": {},
"aggs": null
}
New API: Get Details of a CRS Policy
| New or Updated APIs | New |
|---|---|
| API Endpoint (New version) | /csapi/v1.3/crsPolicy/{policyId} |
| Method | GET |
| DTD XSD Changes | No |
Input ParametersInput Parameters
| Parameter | Mandatory/Optional | Data Type | Description |
|---|---|---|---|
| policyId | Mandatory | string | Specify the UUID of the CRS policy. |
Sample: Get Details of a CRS PolicySample: Get Details of a CRS Policy
API Request
curl -X 'GET' \ '<qualys_base_url>/csapi/v1.3/crsPolicy/8115f2fd-0ab1-4114-b1b2-d3ce04d5c9b9' \ -H 'accept: application/json' \ -H 'Authorization: Bearer <token>'
API Response
{
"customerUuid": "7cd2ffbb-d2bf-5637-8050-a89cc2ab5402",
"uuid": "8115f2fd-0ab1-4114-b1b2-d3ce04d5c9b9",
"policyName": "test1",
"policyDescription": "",
"ownerModule": null,
"createdBy": "arthxas27",
"created": 1791355517308,
"updatedBy": "arthxas27",
"updated": 1791355517308,
"policyMode": true,
"version": 1,
"rulesUuidSet": [
"aea38e49-e4a5-43e5-9b7f-0262714b6ac2"
],
"clustersUuidSet": [
"7f379df1-a9d5-4e16-b9e2-e5f8cf03dce5"
],
"podLabels": [
"app:nginx1"
],
"tagIds": [
{
"uuid": "457f8288-0f8c-4618-bbf0-fc65176e2fc6",
"id": 174236469,
"name": "arth",
"criticalityScore": 0,
"backgroundColor": "#000000",
"foregroundColor": "#000000",
"icon": null,
"tagType": null
}
]
}
The request and the response use different formats for the following fields:
podLabels: You send the pod labels as a JSON object, for example, "app": "nginx1". The API returns them as an array of key:value strings.
tagIds: You send an array of tag UUIDs. The API returns an array of tag objects.
New API: Update a CRS Policy
| New or Updated APIs | New |
|---|---|
| API Endpoint (New version) | /csapi/v1.3/crsPolicy/{policyId} |
| Method | PUT |
| DTD XSD Changes | No |
Input ParametersInput Parameters
| Parameter | Mandatory/Optional | Data Type | Description |
|---|---|---|---|
| policyId | Mandatory | string | Specify the UUID of the CRS policy. |
| policyName | Mandatory | string | Specify the name of the policy. |
| policyDescription | Optional | string | Specify a description for the policy. |
| policyMode | Mandatory | boolean | Specify whether the policy is enabled. true enables the policy and false disables it. |
| clustersUuidSet | Mandatory | array of strings | Specify the UUIDs of the clusters to which the policy applies. |
| podLabels | Optional | object (key-value pairs) | Specify the pod labels as key-value pairs. Example: "app": "nginx1" |
| rulesUuidSet | Mandatory | array of strings | Specify the UUIDs of the rules to attach to the policy. |
| tagIds | Optional | array of strings | Specify the UUIDs of the tags. |
Sample: Update a CRS PolicySample: Update a CRS Policy
API Request
curl -X 'PUT' \
'<qualys_base_url>/csapi/v1.3/crsPolicy/8115f2fd-0ab1-4114-b1b2-d3ce04d5c9b9' \
-H 'accept: application/json' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{
"policyName": "test1234",
"policyDescription": "hhfhtju",
"policyMode": true,
"clustersUuidSet": [
"7f379df1-a9d5-4e16-b9e2-e5f8cf03dce5"
],
"podLabels": {
"app": "nginx12345"
},
"rulesUuidSet": [
"aea38e49-e4a5-43e5-9b7f-0262714b6ac2"
],
"tagIds": [
"457f8288-0f8c-4618-bbf0-fc65176e2fc6"
]
}'
API Response
{
"uuid": "8115f2fd-0ab1-4114-b1b2-d3ce04d5c9b9"
}
New API: Delete a CRS Policy
| New or Updated APIs | New |
|---|---|
| API Endpoint (New version) | /csapi/v1.3/crsPolicy/{policyId} |
| Method | DELETE |
| DTD XSD Changes | No |
Input ParametersInput Parameters
| Parameter | Mandatory/Optional | Data Type | Description |
|---|---|---|---|
| policyId | Mandatory | string | Specify the UUID of the CRS policy. |
Sample: Delete a CRS PolicySample: Delete a CRS Policy
API Request
curl -X 'DELETE' \ '<qualys_base_url>/csapi/v1.3/crsPolicy/8115f2fd-0ab1-4114-b1b2-d3ce04d5c9b9' \ -H 'accept: application/json' \ -H 'Authorization: Bearer <token>'
API Response
{
"uuid": "8115f2fd-0ab1-4114-b1b2-d3ce04d5c9b9"
}
New Image and Container Compliance Report Templates
You can now generate compliance reports that list the result of each compliance control (CID) for every image or container. Earlier, a compliance report for multiple images or containers showed only the overall compliance status (pass or fail), and the individual CIDs and their results weren't included.
To get these per-image and per-container CID results, use the following new report templates.
CS_IMAGE_COMPLIANCE: Image Compliance reportCS_CONTAINER_COMPLIANCE: Container Compliance report
The following API is updated.
- Create a Report Request
POST /csapi/v1.3/reports
Updated API: Create a Report Request
| New or Updated APIs | Updated |
|---|---|
| API Endpoint (New version) | /csapi/v1.3/reports |
| Method | POST |
| DTD XSD Changes | No |
Input ParametersInput Parameters
The following parameters take new values.
| Parameter | Mandatory/Optional | Data Type | Description |
|---|---|---|---|
| templateName | Mandatory | string | Specify the template for the report you want to create. The following values are new:
|
| displayColumns | Optional | string | Specify the columns to include in the report. Separate multiple columns with commas.
When the template CS_IMAGE_COMPLIANCE is used, you can include any of these columns: cid, imageId, status, criticality, controlName, lastEvaluatedOn, policy, repository, imageSha, imageUuid, remediation, and findings. The default columns are: cid, imageId. When the template CS_CONTAINER_COMPLIANCE is used, you can include any of these columns: cid, containerId, imageId, status, criticality, controlName, lastEvaluatedOn, policy, remediation, and findings. The default columns are: cid, containerId. |
Sample: Create a Report Request Using CS_IMAGE_COMPLIANCESample: Create a Report Request Using CS_IMAGE_COMPLIANCE
API Request
curl -X 'POST' \
'<qualys_base_url>/csapi/v1.3/reports' \
-H 'accept: application/json' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{
"name": "image_compliance_report",
"description": "Image compliance report with CID results",
"templateName": "CS_IMAGE_COMPLIANCE",
"filter": null,
"timezone": "Asia/Kolkata",
"format": "csv",
"reportScheduleDetails": null,
"expireAfter": 7,
"secondFilter": "",
"displayColumns": [
"cid", "imageId", "status", "criticality", "controlName",
"lastEvaluatedOn", "policy", "repository", "imageSha", "imageUuid",
"remediation", "findings"
],
"zip": 0,
"emailNotification": 0
}'
API Response
{
"reportUuid": "5d1e3b60-8f2a-11f1-9c4e-2b7a1f0c6d34"
}
Sample: Create a Report Request Using CS_CONTAINER_COMPLIANCESample: Create a Report Request Using CS_CONTAINER_COMPLIANCE
API Request
curl -X 'POST' \
'<qualys_base_url>/csapi/v1.3/reports' \
-H 'accept: application/json' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{
"name": "container_compliance_report",
"description": "Container compliance report with CID results",
"templateName": "CS_CONTAINER_COMPLIANCE",
"filter": null,
"timezone": "Asia/Kolkata",
"format": "csv",
"reportScheduleDetails": null,
"expireAfter": 7,
"secondFilter": "",
"displayColumns": [
"cid", "containerId", "imageId", "status", "criticality",
"controlName", "lastEvaluatedOn", "policy", "remediation", "findings"
],
"zip": 0,
"emailNotification": 0
}'
API Response
{
"reportUuid": "a37c9e10-8f2b-11f1-9c4e-2b7a1f0c6d34"
}