Enterprise TruRisk™ Platform Release 3.21.1 API

July 01, 2021

Asset Management

Asset Management APIs: Display Tag Evaluation Status for Asset Tags

We have added two new parameters in the API response— reEvalStatus and reEvalStatusProgress for the Get Tag Info API (/qps/rest/2.0/get/am/tag/<id>) and Search Tags API (/qps/rest/2.0/search/am/tag). With the introduction of these parameters, you can view the tag re-evaluation status, and tag evaluation progress for the asset tags.

New Parameters in API Response

The following new parameters are added to the Get Tag Info API and Search Tags API response:

Parameter Name Description
reEvalStatus This parameter displays the tag re-evaluation status. The following are the possible values:

In Progress - The tag re-evaluation is in progress.
Completed - The tag re-evaluation is completed.
reEvalStatusProgress This parameter displays the tag re-evaluation progress in percentage. For example, reEvalStatusProgress=75 means the tag re-evaluation progress is 75%.

Updated API: Search Tags API

New or Updated API Updated
API Endpoint /qps/rest/2.0/search/am/tag
Method POST
DTD or XSD Changes No

Sample — View Tag Re-evaluation Status and Progress for Search Tags APISample — View Tag Re-evaluation Status and Progress for Search Tags API

API Request


    curl -u "USERNAME:PASSWORD" -H "content-type: text/xml" -X "POST" 
    --data-binary @- "<qualys_base_url>/qps/rest/2.0/search/am/tag/"
    

API Response


    {
    "ServiceResponse": {
      "responseCode": "SUCCESS",
      "data": [
        {
          "Tag": {
            "color": "#FF6600",
            "parentTagId": 14016196,
            "created": "2019-09-12T02:59:56Z",
            "id": 12345678,
            "modified": "2023-03-06T16:50:46Z",
            "name": "US-East Coast",
            "criticalityScore": 2,
            "reEvalStatus": "Completed | In Progress",
            "reEvalStatusProgress": 75
            }
         }
         ],
      "count": 1
      }
    }
    

Updated API: Get Tag Info API

New or Updated API Updated
API Endpoint /qps/rest/2.0/get/am/tag/<id>
Method POST
DTD or XSD Changes No

Sample — View Tag Re-evaluation Status and Progress for Get Tag Info APISample — View Tag Re-evaluation Status and Progress for Get Tag Info API

The following sample illustrates getting tag re-evaluation status and progress for Get Tag Info API.

API Request


    curl -n -u &quot;USERNAME:PASSWORD&quot;
    &quot;<qualys_base_url>/qps/rest/2.0/get/am/tag/12345&quot; 

API Response


     {
       "ServiceResponse": {
         "responseCode": "SUCCESS",
         "data": [
           {
             "Tag": {
               "parentTagId": 12861796,
               "created": "2019-04-18T09:37:30Z",
               "id": 12861797,
               "modified": "2019-04-18T09:37:30Z",
               "name": "Unassigned Business Unit",
               "reEvalStatus": "Completed | In Progress",
               "reEvalStatusProgress": 75
               }
             }
           ],
         "hasMoreRecords": "true",
         "lastId": 41807341,
         "count": 100
       }
    }
    

Issues Addressed

The following important and notable issues are fixed in this release.

Component/Category Application Description
QID Detection WAS API We fixed an issue in which a few information-gathering QIDs were not reporting all necessary data, such as SSL/TLS and certificate issues.

Affected API Endpoint: /qps/rest/3.0/search/was/finding/