JSON Support

Qualys Asset Management and Tagging API supports JSON requests and responses starting with version 2.11. Samples are shown below.

Headers used in samplesHeaders used in samples

Headers

Samples

Send JSON request

"Content-Type: application/json"

Get response in JSON

"Accept: application/json"

Sample 1 - Create a tagSample 1 - Create a tag

API request

"cat createTag.json | curl -s -k -X POST -H""Accept: application/json""-H""Content-Type: application/json""-H""user: acme_ss2""-H""password: passwd""-d @-""<qualys_base_url>/qps/rest/2.0/create/am/tag""POST data":{
   "ServiceRequest":{
      "data":{
         "Tag":{
            "name":"Parent Tag",
            "ruleType":"NAME_CONTAINS",
            "ruleText":"windows",
            "color":"#FFFFFF",
            "children":{
               "set":{
                  "TagSimple":[
                     {
                        "name":"Child 1"
                     },
                     {
                        "name":"Child 2"
                     }
                  ]
               }
            }
         }
      }
   }
}      
    

JSON output

{
   "ServiceResponse":{
      "data":[
         {
            "Tag":{
               "ruleText":"windows",
               "color":"#FFFFFF",
               "modified":"2016-01-04T19:51:56Z",
               "name":"Parent Tag",
               "children":{
                  "list":[
                     {
                        "TagSimple":{
                           "name":"Child 2",
                           "id":2066216
                        }
                     },
                     {
                        "TagSimple":{
                           "name":"Child 1",
                           "id":2066217
                        }
                     }
                  ]
               },
               "created":"2016-01-04T19:51:56Z",
               "ruleType":"NAME_CONTAINS",
               "id":2066215
            }
         }
      ],
      "count":1,
      "responseCode":"SUCCESS"
   }
}      
    

Sample 2 - Search tagsSample 2 - Search tags

API request

"cat searchTag.json | curl -s -k -X POST -H""Accept: application/json""-H""Content-Type: application/json""-H""user: acme_ss2""-H""password: passwd""-d @-""<qualys_base_url>/qps/rest/2.0/search/am/tag""POST data":{
   "ServiceRequest":{
      "filters":{
         "Criteria":[
            {
               "field":"parent",
               "operator":"EQUALS",
               "value":"2035617"
            },
            {
               "field":"name",
               "operator":"CONTAINS",
               "value":"child"
            },
            {
               "field":"id",
               "operator":"IN",
               "value":"2035619,2035618,2029815"
            },
            {
               "field":"ruleType",
               "operator":"EQUALS",
               "value":"GROOVY"
            },
            {
               "field":"color",
               "operator":"EQUALS",
               "value":"#EC7000"
            }
         ]
      }
   }
}      
    

JSON output

{
   "ServiceResponse":{
      "data":[
         {
            "Tag":{
               "ruleText":"windows",
               "color":"#FFFFFF",
               "modified":"2016-01-04T19:51:56Z",
               "name":"Parent Tag",
               "children":{
                  "list":[
                     {
                        "TagSimple":{
                           "name":"Child 2",
                           "id":2066216
                        }
                     },
                     {
                        "TagSimple":{
                           "name":"Child 1",
                           "id":2066217
                        }
                     }
                  ]
               },
               "created":"2016-01-04T19:51:56Z",
               "ruleType":"NAME_CONTAINS",
               "id":2066215
            }
         }
      ],
      "count":1,
      "responseCode":"SUCCESS"
   }
}