Custom Assessment and Remediation Release 2.5.2 API

End-of-Support for an API version signifies the point at which Qualys will no longer actively maintain or enhance that specific version. While the API may continue to function, it will not receive new features, performance improvements, or security updates. This phase is intended to provide a grace period for API consumers to migrate to newer versions.

Implications of End-of-Support

• No New Features: The API version will not receive any further functional enhancements or new capabilities.
• Limited Bug Fixes: Critical security vulnerabilities may be addressed on a case-by-case basis, but general bug fixes for non-critical issues will stop.
• No Performance Improvements: Optimization efforts focus solely on newer API versions.
• Reduced Support Channels: Technical support for issues related to this specific API version may become limited, and users are strongly recommended to upgrade.
• No Guarantees of Reliability: While the API may remain operational, Qualys offers no guarantees regarding its continued reliability beyond the EOS date.

End-of-Life for an API version is the final stage where the API version is officially retired and will be completely decommissioned. After the EOL date, the API will no longer be available, and any calls to it will result in errors. This marks the complete discontinuation of service for that specific API version.

Implications of End-of-Life

• API Decommissioning: The API endpoint for this version is shut down and will no longer accept requests.
• Complete Service Stoppage: All functionalities provided by this API version will cease to exist.
• Error Responses: Any attempt to call the EOL API results in HTTP error codes, such as 404 Not Found or 410 Gone, or similar error messages.
• No Support: All forms of support, documentation, and resources related to this API version will be discontinued.

API Request

curl -X POST 
'<qualys_base_url>/sm/v2/block-commands/update'
-header 'Content-Type: application/json'
-header 'Authorization: Bearer {{authToken}}'
-data '{
    "languageId": 201,
    "commandId": 206,
    "commands": "cmd1,cmd2,cmd3,cmd4",
    "user": {
      "id": "9321f0b3-5372-4107-817c-d5647de6da11",
      "name": "string",
      "userName": "string"
    }
  }'

Response

{
 "body": "Commands Updated Successfully"
}

API Request

curl -X POST
'<qualys_base_url>/sm/v2/block-commands/delete'
-header 'Content-Type: application/json'
-header 'Authorization: Bearer {{authToken}}'
-data '{
    "commandIds": [2,3],
    "user": {
      "id": "9321x0x3-5372-4107-817x-x5647xx6Xx11",
      "name": "string",
      "userName": "string"
    }
  }'

Response

{
  "body": "Commands Deleted Successfully"
}

API Request

curl -X POST
'<qualys_base_url>/sm/v5/script'
--header 'Accept: application/vnd.qualys.car.api.v5.0+json'
--header 'Authorization: Bearer <authToken>'
--header 'Content-Type: application/json'
--data-raw
'{
    "categoryId": 605,
    "content": "bHMgLWx0cg==",
    "description": "sample description",
    "platform": "WINDOWS",
    "severity": "3",
    "threshold":300,
    "thresholdTimeUnit": "SECOND",
    "title": "Sample title",
    "typeId": 2,
    "languageId": 204,
    "scriptApprovalUserConsent": true,
    "hasParameters": true,
    "customQid": {
        "type": "Detection QID",
        "severity": "4",
        "qds": "75",
        "vulnerabilityType": "Information_Gathered",
        "cveIds": "CVE-2023-3452",
        "detectionLogic": "Use Script",
        "detectionRegex": [
            {
                "regex": [
                    "java 9"
                ],
                "cardinality": "CONTAINS",
                "status": "detected"
            },
            {
                "regex": [
                    "java 11"
                ],
                "cardinality": "CONTAINS",
                "status": "not-detected"
            }
        ],
    "params": [
        {
            "key": "string",
            "value": "string"
        }
    ]
}'

Response

{
  "errorCode": "0",
  "message": "Script created successfully",
  "body": {
    "id": 213673
  }
}

API Request

curl -X PATCH
'<qualys_base_url>/sm/v4/script/{ScriptId}'
--header 'Accept: application/vnd.qualys.car.api.v4.0+json'
--header 'Authorization: Bearer <authToken>'
--header 'Content-Type: application/json'
--data-raw 
'{
    "categoryId": 605,
    "content": "bHMgLWx0cg==",
    "description": "sample description",
    "platform": "WINDOWS",
    "severity": "3",
    "threshold":300,
    "thresholdTimeUnit": "SECOND",
    "title": "Sample title",
    "typeId": 2,
    "languageId": 204,
    "scriptApprovalUserConsent": true,
    "hasParameters": true,
    "customQid": {
        "type": "Detection QID",
        "severity": "4",
        "qds": "75",
        "vulnerabilityType": "Information_Gathered",
        "cveIds": "CVE-2023-3452",
        "detectionLogic": "Use Script",
        "detectionRegex": [
            {
                "regex": [
                    "java 9"
                ],
                "cardinality": "CONTAINS",
                "status": "detected"
            },
            {
                "regex": [
                    "python"
                ],
                "cardinality": "CONTAINS",
                "status": "not-detected"
            }
        ],
    "params": [
        {
            "key": "string",
            "value": "string"
        }
    ]
}'

Response

{
  "id": 213673,
  "message": "Updated Successfully."
}