YAML Support


WAS API supports YAML requests and responses starting with WAS version 8.17. Sample is shown below.

Sample 1 - Create a web applicationSample 1 - Create a web application

API request

curl -u "USERNAME:PASSWORD" -H "content-type: text/xml" -X "POST" --data-binary @-"<qualys_base_url>/qps/rest/3.0/create/was/webapp/" < file.xml
Note: “file.xml” contains the request POST data.
 
POST data:
<ServiceRequest>
    <data>
        <WebApp>
            <name>
                <![CDATA[TEST YAML API]]>
            </name>
            <url>http://10.12.14.16</url>
            <swaggerFile>
                <name>ajax.yml</name>
                <content>LS0tCnN3YWdnZXI6ICcyLjAnCmluZm86CiAgZGVzY3JpcHRpb246IFRoaXMgaXMgYSBzYW1wbGUgUkVTVCBhcGkgc2VydmVyLgogIHZlcnNpb246IDEuMC4wCiAgdGl0bGU6IFN3YWdnZXIgV2l0aCBWdWxuZXJhYmlsaXR5CiAgdGVybXNPZlNlcnZpY2U6IGh0dHA6Ly9zd2FnZ2VyLmlvL3Rlcm1zLwogIGNvbnRhY3Q6CiAgICBlbWFpbDogYWJjQGd4bWFpbC5jb20KICBsaWNlbnNlOgogICAgbmFtZTogQXBhY2hlIDIuMAogICAgdXJsOiBodHRwOi8vd3d3LmFwYWNoZS5vcmcvbGljZW5zZXMvTElDRU5TRS0yLjAuaHRtbApob3N0OiAxMC4xMS42OS4yMQpiYXNlUGF0aDogIi9KU09OIgp0YWdzOgotIG5hbWU6IHNlYXJjaAogIGRlc2NyaXB0aW9uOiBTZWFyY2gKICBleHRlcm5hbERvY3M6CiAgICBkZXNjcmlwdGlvbjogRmluZCBvdXQgbW9yZQogICAgdXJsOiBodHRwOi8vc3dhZ2dlci5pbwotIG5hbWU6IHNlYXJjaDIKICBkZXNjcmlwdGlvbjogQWNjZXNzIHRvIFBldHN0b3JlIG9yZGVycwotIG5hbWU6IHVzZXIKICBkZXNjcmlwdGlvbjogT3BlcmF0aW9ucyBhYm91dCB1c2VyCiAgZXh0ZXJuYWxEb2NzOgogICAgZGVzY3JpcHRpb246IEZpbmQgb3V0IG1vcmUgYWJvdXQgb3VyIHN0b3JlCiAgICB1cmw6IGh0dHA6Ly9zd2FnZ2VyLmlvCnNjaGVtZXM6Ci0gaHR0cApwYXRoczoKICAiLzIvYWpheF9zZWFyY2hfMS5waHAiOgogICAgcG9zdDoKICAgICAgdGFnczoKICAgICAgLSBzZWFyY2gKICAgICAgc3VtbWFyeTogU2VhcmNoIGZvciBoaXN0b3J5CiAgICAgIGRlc2NyaXB0aW9uOiAnJwogICAgICBvcGVyYXRpb25JZDogc2VhcmNoMQogICAgICBjb25zdW1lczoKICAgICAgLSBhcHBsaWNhdGlvbi9qc29uCiAgICAgIHByb2R1Y2VzOgogICAgICAtIHRleHQvaHRtbAogICAgICBwYXJhbWV0ZXJzOgogICAgICAtIGluOiBib2R5CiAgICAgICAgbmFtZTogYm9keQogICAgICAgIGRlc2NyaXB0aW9uOiBTZWFyY2ggcGFyYW1ldGVycwogICAgICAgIHJlcXVpcmVkOiB0cnVlCiAgICAgICAgc2NoZW1hOgogICAgICAgICAgIiRyZWYiOiAiIy9kZWZpbml0aW9ucy9TZWFyY2gxIgogICAgICByZXNwb25zZXM6CiAgICAgICAgJzIwMCc6CiAgICAgICAgICBkZXNjcmlwdGlvbjogU3VjY2VzcwogICAgICAgICc0MTUnOgogICAgICAgICAgZGVzY3JpcHRpb246IFVuc3VwcG9ydGVkIG1lZGlhCiAgICAgICAgJzQyOSc6CiAgICAgICAgICBkZXNjcmlwdGlvbjogVG9vIG1hbnkgcmVxdWVzdHMKICAgICAgICBkZWZhdWx0OgogICAgICAgICAgZGVzY3JpcHRpb246IERlZmF1bHQgZXJyb3IgcmVzcG9uc2UKICAiLzIvYWpheF9zZWFyY2hfMi5waHAiOgogICAgcG9zdDoKICAgICAgdGFnczoKICAgICAgLSBzZWFyY2gyCiAgICAgIHN1bW1hcnk6IFNlYXJjaCBmb3IgaGlzdG9yeTIKICAgICAgb3BlcmF0aW9uSWQ6IHNlYXJjaDIKICAgICAgY29uc3VtZXM6CiAgICAgIC0gYXBwbGljYXRpb24vanNvbgogICAgICBwcm9kdWNlczoKICAgICAgLSB0ZXh0L2h0bWwKICAgICAgcGFyYW1ldGVyczoKICAgICAgLSBpbjogYm9keQogICAgICAgIG5hbWU6IGJvZHkKICAgICAgICBkZXNjcmlwdGlvbjogU2VhcmNoIHBhcmFtZXRlcnMKICAgICAgICByZXF1aXJlZDogdHJ1ZQogICAgICAgIHNjaGVtYToKICAgICAgICAgICIkcmVmIjogIiMvZGVmaW5pdGlvbnMvU2VhcmNoMiIKICAgICAgcmVzcG9uc2VzOgogICAgICAgICcyMDAnOgogICAgICAgICAgZGVzY3JpcHRpb246IFN1Y2Nlc3MKICAgICAgICAnNDE1JzoKICAgICAgICAgIGRlc2NyaXB0aW9uOiBVbnN1cHBvcnRlZCBtZWRpYQogICAgICAgICc0MjknOgogICAgICAgICAgZGVzY3JpcHRpb246IFRvbyBtYW55IHJlcXVlc3RzCiAgICAgICAgZGVmYXVsdDoKICAgICAgICAgIGRlc2NyaXB0aW9uOiBEZWZhdWx0IGVycm9yIHJlc3BvbnNlCmRlZmluaXRpb25zOgogIFNlYXJjaDE6CiAgICB0eXBlOiBvYmplY3QKICAgIHByb3BlcnRpZXM6CiAgICAgIGxpbWl0OgogICAgICAgIHR5cGU6IGludGVnZXIKICAgICAgICBmb3JtYXQ6IGludDY0CiAgICAgICAgbWF4aW11bTogMjAwMAogICAgICAgIG1pbmltdW06IDEwCiAgICAgIG9yZGVyOgogICAgICAgIHR5cGU6IHN0cmluZwogICAgICAgIGVudW06CiAgICAgICAgLSBhc2MKICAgICAgICAtIGRlc2MKICAgICAgdGVybToKICAgICAgICB0eXBlOiBzdHJpbmcKICAgICAgICBtaW5MZW5ndGg6IDEKICAgICAgICBtYXhMZW5ndGg6IDIwCiAgICAgICAgcGF0dGVybjogIlthLXpBLVowLTlfXSIKICBTZWFyY2gyOgogICAgdHlwZTogb2JqZWN0CiAgICBwcm9wZXJ0aWVzOgogICAgICBsaW1pdDI6CiAgICAgICAgdHlwZTogaW50ZWdlcgogICAgICAgIGZvcm1hdDogaW50NjQKICAgICAgICBtYXhpbXVtOiAyMDAwCiAgICAgICAgbWluaW11bTogMTAKICAgICAgb3JkZXIyOgogICAgICAgIHR5cGU6IHN0cmluZwogICAgICAgIGVudW06CiAgICAgICAgLSBhc2MKICAgICAgICAtIGRlc2MKICAgICAgdGVybTI6CiAgICAgICAgdHlwZTogc3RyaW5nCiAgICAgICAgbWluTGVuZ3RoOiAxCiAgICAgICAgbWF4TGVuZ3RoOiAyMAogICAgICAgIHBhdHRlcm46ICJbYS16QS1aMC05X10iCiAgICAgIG9mZnNldDI6CiAgICAgICAgdHlwZTogaW50ZWdlcgogICAgICAgIGZvcm1hdDogaW50NjQKICAgICAgICBtYXhpbXVtOiAyOTM4MjQ3MzIKICAgICAgICBtaW5pbXVtOiAxCmV4dGVybmFsRG9jczoKICBkZXNjcmlwdGlvbjogRmluZCBvdXQgbW9yZSBhYm91dCBTd2FnZ2VyCiAgdXJsOiBodHRwOi8vc3dhZ2dlci5pbwo=</content>
            </swaggerFile>
        </WebApp>
    </data>
</ServiceRequest>      
    

YAML output

<?xml version="1.0" encoding="UTF-8"?>
<ServiceResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="<qualys_base_url>/qps/xsd/3.0/was/webapp.xsd">
<responseCode>SUCCESS</responseCode>
<count>1</count>
<data>
<WebApp>
<id>14763246</id>
<name>
<![CDATA[TEST YAML API]]>
</name>
<url>
<![CDATA[http://10.12.14.16]]>
</url>
<owner>
<id>8296038</id>
<username>quays_abc</username>
<firstName>
<![CDATA[John]]>
</firstName>
<lastName>
<![CDATA[Doe]]>
</lastName>
</owner>
<scope>ALL</scope>
<attributes>
<count>0</count>
</attributes>
<defaultScanner>
<type>EXTERNAL</type>
</defaultScanner>
<scannerLocked>false</scannerLocked>
<progressiveScanning>DISABLED</progressiveScanning>
<urlBlacklist>
<count>0</count>
</urlBlacklist>
<urlWhitelist>
<count>0</count>
</urlWhitelist>
<postDataBlacklist>
<count>0</count>
</postDataBlacklist>
<logoutRegexList>
<count>0</count>
</logoutRegexList>
<authRecords>
<count>0</count>
</authRecords>
<dnsOverrides>
<count>0</count>
</dnsOverrides>
<useRobots>IGNORE</useRobots>
<useSitemap>false</useSitemap>
<malwareMonitoring>false</malwareMonitoring>
<malwareNotification>false</malwareNotification>
<tags>
<count>0</count>
</tags>
<comments>
<count>0</count>
</comments>
<isScheduled>false</isScheduled>
<createdBy>
<id>8296038</id>
<username>quays_abc</username>
<firstName>
<![CDATA[John]]>
</firstName>
<lastName>
<![CDATA[Doe]]>
</lastName>
</createdBy>
<createdDate>2022-06-02T09:27:50Z</createdDate>
<updatedBy>
<id>8296038</id>
<username>quays_abc</username>
<firstName>
<![CDATA[John]]>
</firstName>
<lastName>
<![CDATA[Doe]]>
</lastName>
</updatedBy>
<updatedDate>2022-06-02T09:27:50Z</updatedDate>
<config/>
<crawlingScripts>
<count>0</count>
</crawlingScripts>
<swaggerFile>
<id>10291</id>
<name>ajax.yml</name>
<content>LS0tCnN3YWdnZXI6ICcyLjAnCmluZm86CiAgZGVzY3JpcHRpb246IFRoaXMgaXMgYSBzYW1wbGUgUkVTVCBhcGkgc2VydmVyLgogIHZlcnNpb246IDEuMC4wCiAgdGl0bGU6IFN3YWdnZXIgV2l0aCBWdWxuZXJhYmlsaXR5CiAgdGVybXNPZlNlcnZpY2U6IGh0dHA6Ly9zd2FnZ2VyLmlvL3Rlcm1zLwogIGNvbnRhY3Q6CiAgICBlbWFpbDogYWJjQGd4bWFpbC5jb20KICBsaWNlbnNlOgogICAgbmFtZTogQXBhY2hlIDIuMAogICAgdXJsOiBodHRwOi8vd3d3LmFwYWNoZS5vcmcvbGljZW5zZXMvTElDRU5TRS0yLjAuaHRtbApob3N0OiAxMC4xMS42OS4yMQpiYXNlUGF0aDogIi9KU09OIgp0YWdzOgotIG5hbWU6IHNlYXJjaAogIGRlc2NyaXB0aW9uOiBTZWFyY2gKICBleHRlcm5hbERvY3M6CiAgICBkZXNjcmlwdGlvbjogRmluZCBvdXQgbW9yZQogICAgdXJsOiBodHRwOi8vc3dhZ2dlci5pbwotIG5hbWU6IHNlYXJjaDIKICBkZXNjcmlwdGlvbjogQWNjZXNzIHRvIFBldHN0b3JlIG9yZGVycwotIG5hbWU6IHVzZXIKICBkZXNjcmlwdGlvbjogT3BlcmF0aW9ucyBhYm91dCB1c2VyCiAgZXh0ZXJuYWxEb2NzOgogICAgZGVzY3JpcHRpb246IEZpbmQgb3V0IG1vcmUgYWJvdXQgb3VyIHN0b3JlCiAgICB1cmw6IGh0dHA6Ly9zd2FnZ2VyLmlvCnNjaGVtZXM6Ci0gaHR0cApwYXRoczoKICAiLzIvYWpheF9zZWFyY2hfMS5waHAiOgogICAgcG9zdDoKICAgICAgdGFnczoKICAgICAgLSBzZWFyY2gKICAgICAgc3VtbWFyeTogU2VhcmNoIGZvciBoaXN0b3J5CiAgICAgIGRlc2NyaXB0aW9uOiAnJwogICAgICBvcGVyYXRpb25JZDogc2VhcmNoMQogICAgICBjb25zdW1lczoKICAgICAgLSBhcHBsaWNhdGlvbi9qc29uCiAgICAgIHByb2R1Y2VzOgogICAgICAtIHRleHQvaHRtbAogICAgICBwYXJhbWV0ZXJzOgogICAgICAtIGluOiBib2R5CiAgICAgICAgbmFtZTogYm9keQogICAgICAgIGRlc2NyaXB0aW9uOiBTZWFyY2ggcGFyYW1ldGVycwogICAgICAgIHJlcXVpcmVkOiB0cnVlCiAgICAgICAgc2NoZW1hOgogICAgICAgICAgIiRyZWYiOiAiIy9kZWZpbml0aW9ucy9TZWFyY2gxIgogICAgICByZXNwb25zZXM6CiAgICAgICAgJzIwMCc6CiAgICAgICAgICBkZXNjcmlwdGlvbjogU3VjY2VzcwogICAgICAgICc0MTUnOgogICAgICAgICAgZGVzY3JpcHRpb246IFVuc3VwcG9ydGVkIG1lZGlhCiAgICAgICAgJzQyOSc6CiAgICAgICAgICBkZXNjcmlwdGlvbjogVG9vIG1hbnkgcmVxdWVzdHMKICAgICAgICBkZWZhdWx0OgogICAgICAgICAgZGVzY3JpcHRpb246IERlZmF1bHQgZXJyb3IgcmVzcG9uc2UKICAiLzIvYWpheF9zZWFyY2hfMi5waHAiOgogICAgcG9zdDoKICAgICAgdGFnczoKICAgICAgLSBzZWFyY2gyCiAgICAgIHN1bW1hcnk6IFNlYXJjaCBmb3IgaGlzdG9yeTIKICAgICAgb3BlcmF0aW9uSWQ6IHNlYXJjaDIKICAgICAgY29uc3VtZXM6CiAgICAgIC0gYXBwbGljYXRpb24vanNvbgogICAgICBwcm9kdWNlczoKICAgICAgLSB0ZXh0L2h0bWwKICAgICAgcGFyYW1ldGVyczoKICAgICAgLSBpbjogYm9keQogICAgICAgIG5hbWU6IGJvZHkKICAgICAgICBkZXNjcmlwdGlvbjogU2VhcmNoIHBhcmFtZXRlcnMKICAgICAgICByZXF1aXJlZDogdHJ1ZQogICAgICAgIHNjaGVtYToKICAgICAgICAgICIkcmVmIjogIiMvZGVmaW5pdGlvbnMvU2VhcmNoMiIKICAgICAgcmVzcG9uc2VzOgogICAgICAgICcyMDAnOgogICAgICAgICAgZGVzY3JpcHRpb246IFN1Y2Nlc3MKICAgICAgICAnNDE1JzoKICAgICAgICAgIGRlc2NyaXB0aW9uOiBVbnN1cHBvcnRlZCBtZWRpYQogICAgICAgICc0MjknOgogICAgICAgICAgZGVzY3JpcHRpb246IFRvbyBtYW55IHJlcXVlc3RzCiAgICAgICAgZGVmYXVsdDoKICAgICAgICAgIGRlc2NyaXB0aW9uOiBEZWZhdWx0IGVycm9yIHJlc3BvbnNlCmRlZmluaXRpb25zOgogIFNlYXJjaDE6CiAgICB0eXBlOiBvYmplY3QKICAgIHByb3BlcnRpZXM6CiAgICAgIGxpbWl0OgogICAgICAgIHR5cGU6IGludGVnZXIKICAgICAgICBmb3JtYXQ6IGludDY0CiAgICAgICAgbWF4aW11bTogMjAwMAogICAgICAgIG1pbmltdW06IDEwCiAgICAgIG9yZGVyOgogICAgICAgIHR5cGU6IHN0cmluZwogICAgICAgIGVudW06CiAgICAgICAgLSBhc2MKICAgICAgICAtIGRlc2MKICAgICAgdGVybToKICAgICAgICB0eXBlOiBzdHJpbmcKICAgICAgICBtaW5MZW5ndGg6IDEKICAgICAgICBtYXhMZW5ndGg6IDIwCiAgICAgICAgcGF0dGVybjogIlthLXpBLVowLTlfXSIKICBTZWFyY2gyOgogICAgdHlwZTogb2JqZWN0CiAgICBwcm9wZXJ0aWVzOgogICAgICBsaW1pdDI6CiAgICAgICAgdHlwZTogaW50ZWdlcgogICAgICAgIGZvcm1hdDogaW50NjQKICAgICAgICBtYXhpbXVtOiAyMDAwCiAgICAgICAgbWluaW11bTogMTAKICAgICAgb3JkZXIyOgogICAgICAgIHR5cGU6IHN0cmluZwogICAgICAgIGVudW06CiAgICAgICAgLSBhc2MKICAgICAgICAtIGRlc2MKICAgICAgdGVybTI6CiAgICAgICAgdHlwZTogc3RyaW5nCiAgICAgICAgbWluTGVuZ3RoOiAxCiAgICAgICAgbWF4TGVuZ3RoOiAyMAogICAgICAgIHBhdHRlcm46ICJbYS16QS1aMC05X10iCiAgICAgIG9mZnNldDI6CiAgICAgICAgdHlwZTogaW50ZWdlcgogICAgICAgIGZvcm1hdDogaW50NjQKICAgICAgICBtYXhpbXVtOiAyOTM4MjQ3MzIKICAgICAgICBtaW5pbXVtOiAxCmV4dGVybmFsRG9jczoKICBkZXNjcmlwdGlvbjogRmluZCBvdXQgbW9yZSBhYm91dCBTd2FnZ2VyCiAgdXJsOiBodHRwOi8vc3dhZ2dlci5pbwo=</content>
<fileSize>2774</fileSize>
</swaggerFile>
</WebApp>
</data>
</ServiceResponse>