List Assets API

Search list of assets on which CAR is enabled.

POST /sm/v1/assets/search

Input ParametersInput Parameters

Parameter

Mandatory/Optional

Data Type

Description

Authorization

Mandatory

string

Authorization token to authenticate to the Qualys Enterprise TruRisk™ Platform.

Prepend the token with 'Bearer', followed by a space. For example:

Bearer <authToken>

SampleSample

API Request:

 curl -X POST 
'https://<qualys_base_url>/sm/v1/assets/search'
--header 'Authorization: Bearer <authToken>     

Response:

 " "{
   "   ""errorCode":null,
   "   ""message":null,
   "   ""body":{
      "  ""totalCount":"<NUMBER OF ASSETS>",
      "   ""list":[
         "   "{
            "   ""sortValues":[
               
            ],
            "   ""data":{
               "   ""interfaces":[
                  "   "{
                     "  ""hostname":"<ASSET NAME>",
                     "  ""macAddress":"<MAC ADDRESS>",
                     "  ""address":"<ASSET IP>",
                     "   ""interfaceName":"eth0""   ",
                     "   "{
                        "   ""hostname":null,
                        "  ""macAddress":"<MAC ADDRESS>",
                        "   ""address":"fe80:0:0:0:82a:39ff:feda:4fa5",
                        "   ""interfaceName":"eth0""   "
                     }"   "
                  ],
                  "  ""address":"<ASSET IP>",
                  "   ""activatedForModules":[
                     "   ""PC""   "
                  ],
                  "   ""operatingSystem":"OPERATING SYSTEM",
                  "   ""assetType":"HOST",
                  "   ""tags":[
                        12047163,
                        11516586,
                        8543820,
                        9738814
   
                  ],
                  "  ""customerUuid":"<CUSTOMER UUID>",
                  "  ""assetId":"<ASSET ID>",
                  "  ""customerId":"<CUSTOMER ID>",
                  "  ""name":"<ASSET NAME>",
                  "  ""agentVersion":"<CLOUD AGENT VERSION>",
                  "  ""id":"<ASSET IP>",
                  "  ""agentUuid":"<AGENT UUID>""   "
               }"   "
            },
            "   "{
               "   ""sortValues":[
                  
               ],
               "   ""data":{
                  "   ""interfaces":[
                     "   "{
                        "  ""hostname":"<HOST NAME>",
                        "  ""macAddress":"<MAC ADDRESS>",
                        "  ""address":"<ASSET IP>",
                        "   ""interfaceName":"ens160""   "
                     },
                     "   "{
                        "   ""hostname":null,
                        "  ""macAddress":"<MAC ADDRESS>",
                        "  ""address":"<ASSET IP>",
                        "   ""interfaceName":"virbr0""   "
                     },
                     "   "{
                        "   ""hostname":null,
                        "  ""macAddress":"<MAC ADDRESS>",
                        "  ""address":"<ASSET IP>",
                        "   ""interfaceName":"ens160""   "
                     }"   "
                  ],
                  "  ""address":"<ASSET IP>",
                  "   ""activatedForModules":[
                     "   ""PC""   "
                  ],
                  "  ""operatingSystem":"<OPERATING SYSTEM>",
                  "   ""assetType":"HOST",
                  "   ""tags":[
                        8543820
   
                  ],
                  "  ""customerUuid":"<CUSTOMER UUID>",
                  "  ""assetId":"<ASSET ID>",
                  "  ""customerId":"<CUSTOMER ID>",
                  "  ""name":"<HOST NAME>",
                  "  ""agentVersion":"<AGENT VERSION>",
                  "  ""id":"<AGENT ID>",
                  "  ""agentUuid":"<AGENT UUID>""   "
               }"   "
            },
            "   "{
               "   ""sortValues":[
                  
               ],
               "   ""data":{
                  "   ""interfaces":[
                     "   "{
                        "  ""hostname":"<ASSET NAME>",
                        "  ""macAddress":"<MAC ADDRESS>",
                        "  ""address":"<ASSET IP>",
                        "   ""interfaceName":"Intel(R) PRO/1000 MT Network Connection""   "
                     }"   "
                  ],
                  "  ""address":"<ASSET IP>",
                  "   ""activatedForModules":[
                     "      ""AGENT_FIM",
                     "      ""AGENT_PC",
                     "      ""FIM",
                     "      ""PC""   "
                  ],
                  "  ""operatingSystem":"<OPERATING SYSTEM>",
                  "   ""assetType":"HOST",
                  "   ""tags":[
                           17970415,
                           12047183,
                           11172212,
                           8546868,
                           14695569,
                           12047182,
                           8543820
   
                  ],
                  "  ""customerUuid":"2<CUSTOMER UUID>",
                  "  ""assetId":"<ASSET ID>",
                  "  ""customerId":"<CUSTOMER ID>",
                  "  ""name":"<ASSET NAME>",
                  "  ""agentVersion":"<AGENT VERSION>",
                  "  ""id":"<AGENT ID>",
                  "  ""agentUuid":"<AGENT UUID>""            "
               }"         "
            }"        "
         ]"      "
      }"   "
   }

To know the details of the response codes, refer to Appendix.