Qualys API (VM, PC) User Guide

1 Qualys API(VM, PC) user GuideVersion 26, 2022 Copyright 2018-2022 by Qualys , Inc. All Rights and the Qualys logo are registered trademarks of Qualys , Inc. All other trademarks are the property of their respective owners. Qualys , Inc. 919 E Hillsdale Blvd 4th Floor Foster City, CA 94404 1 (650) 801 6100 Verity ConfidentialTa b l e o f C o n t e n t 8 Welcome .. 9 API Conventions .. 9 Qualys user Account .. 9 Qualys API Server URL ..10 Making API requests .. 11 API Limits .. 12 Tracking API usage by user .. 13 HTTP Response Headers .. 13 Activity Log .. 16 Authentication to your account ..17 What do I need to know? .. 17 Using Basic HTTP Authentication .. 17 Using Session Based Authentication .. 18 Session Login .. 21 Session Logout.

2 23 Scans ..25VM Scans .. 26VM Scan List .. 26 Launch VM Scan .. 29 Launch VM Scan on EC2 assets .. 31 Manage VM Scans .. 34 Compliance Scans .. 37 Compliance Scan List .. 38 SCAP Scan List ..39 Launch Compliance Scan .. 41 Launch Compliance Scan on EC2 assets .. 42 Manage Compliance Scans .. 44 Cloud Perimeter Scans ..47 Create/Update Cloud Perimeter Scan .. 47VM Scan Schedules .. 50PC Scan Schedules .. 61 Scan List Parameters .. 71 Scan Parameters .. 73 Cloud Perimeter Scan Parameters .. 78 Scan Schedule Parameters .. 82VM Scan Statistics .. 86VM Scan Summary ..89 Scan Summary .. 100 Scanner Details .. 103 Share PCI Scan .. 105 Discovery Scans (maps) .. 109 Scan 118 Scanner Appliance List .. 119 Manage Virtual Scanner Appliances.

3 124 Update Physical Scanner Appliance .. 129 Replace Scanner Appliance .. 132 Scanner Appliance VLANs and Static Routes .. 134 Option Profile Export .. 139 Option Profile Import ..149 Option Profiles for VM ..155 Option Profiles for PCI .. 170 Option Profiles for Compliance .. 178 KnowledgeBase .. 199 KnowledgeBase QVS Download in JSON Format .. 205 Editing Vulnerabilities .. 207 Static Search Lists .. 210 Dynamic Search Lists ..215 Vendor IDs and References .. 226 Scan Permissions Summary .. 230 List Authentication Records .. 231 List Authentication Records by Type .. 233 Application Server Records .. 237 Azure MS SQL Record .. 242 Docker Record .. 247 HTTP Record .. 250 IBM DB2 Record .. 253 InformixDB Record ..258 Infoblox Record.

4 263 JBoss Server record .. 269 Kubernetes Record .. 273 MariaDB Record .. 276 Microsoft SharePoint Record .. 280 MongoDB Record .. 290MS Exchange Server ..298MS SQL Record .. 303 MySQL Record .. 312 Neo4j Record .. 319 Nginx Record .. 324 Oracle Record .. 328 System created Oracle records .. 333 Oracle Listener Record ..336 Oracle WebLogic Server Record .. 338 Palo Alto Firewall Record .. 341 Pivotal Greenplum Record .. 345 PostgreSQL Record .. 352 SAP Hana Record .. 359 SAP IQ Record .. 364 SNMP Record .. 369 Sybase Record .. 374 Unix Record .. 380 Network SSH Record .. 392 VMware Record .. 397 Windows Record .. 402 Oracle HTTP Server Record .. 410vCenter - ESXi Mapping Records .. 420 Vault 426 Vault Support matrix ..426 Vault Definition.

5 432 List Vaults .. 439 Manage Vaults .. 453IP List .. 454 Add IPs .. 457 Update IPs .. 459 Host List .. 463 Host Update .. 475 Host List Detection .. 479 Host List Detection - Normalized Data .. 501 Host List Detection - Use Cases .. 501 Host List Detection - Best Practices .. 503 Excluded Host List .. 503 Excluded Hosts Change History .. 506 Manage Excluded Hosts .. 509 Virtual Host List .. 513 Manage Virtual Hosts ..514 Restricted IPs List .. 517 Manage Restricted IPs ..518 Asset Group List .. 521 Manage Asset Groups .. 524 Purge Hosts .. 529 Patch List .. 536 IPv6 Assets ..538 API Support for IPv6 Asset Management and Scanning .. 538 IPv6 Mapping Record List .. 543 Add IPv6 Mapping Records .. 546 Network List .. 546 Create Network.

6 547 Update Network .. 549 Assign Scanner Appliance to Network .. 550 Reports ..552 Report List .. 553 Launch Report .. 555 Launching Reports Using Asset Tags .. 562 Launching and Fetching Compliance Reports in CSV Format .. 563 Report Template List ..566 Launch Scorecard .. 568 Cancel Running Report .. 575 Download Saved Report .. 576 Delete Saved Report ..582 Scheduled Reports List ..583 Launch Scheduled Report .. 584 Asset Search Report .. 584VM Report Templates .. 596 API Support for Report Templates .. 596 Scan Template .. 597 Cloud Asset Metadata Fields in CSV Format .. 604 Cloud Asset Metadata Fields in XML Format .. 605 PCI Scan Template .. 611 Patch Template .. 613 Map Template .. 621VM Remediation Tickets .. 635 Remediation Tickets overview.

7 635 Ticket Parameters .. 637 View Ticket List .. 639 Edit Tickets .. 641 Delete Tickets .. 643 View Deleted Ticket List .. 645 Get Ticket Information ..646 Set Vulnerabilities to Ignore on Hosts .. 653 Compliance Control List .. 654 Compliance Policy List ..680 Compliance Policy - Export .. 684 Compliance Policy - Import .. 704 Compliance Policy - Merge .. 706 Compliance Policy - Manage Asset Tags .. 712 Compliance Policy - Manage Asset Groups .. 716 Compliance Posture Information .. 719PC Posture Information APIs .. 719PC Posture Streaming APIs .. 739 Get Policy List ..739 Resolve Host IDs .. 742 Get Posture Info .. 744 Control Criticality .. 762 Exceptions .. 763 SCAP Cyberscope Report .. 771 SCAP ARF Report .. 775 SCAP Policy List.

8 776 Users and Activity Log .. 780 user List .. 780 Add/Edit user .. 782 user Registration Process .. 790 Accept Qualys EULA ..791 Activate/Deactivate Users .. 792 user Password Change .. 793 Export user Activity Log .. 795 Appendix A - API 798 Appendix B - Ports used for scanning .. 799 Appendix C - Scan Results 801 Appendix D - Error Codes / 807 PCRS Error Codes .. 809 Appendix E - Streaming Posture API Client Sample Code (Python)812 Index .. 8198 PrefacePrefaceUsing the Qualys API, third parties can integrate their own applications with Qualys cloud security and compliance solutions using an extensible XML interface. The APIs described in this Guide are available to customers using Qualys Cloud Platform (VM, PC).About QualysQualys, Inc.

9 (NASDAQ: QLYS) is a pioneer and leading provider of cloud-based security and compliance solutions. The Qualys Cloud Platform and its integrated apps help businesses simplify security operations and lower the cost of compliance by delivering critical security intelligence on demand and automating the full spectrum of auditing, compliance and protection for IT systems and web applications. Founded in 1999, Qualys has established strategic partnerships with leading managed service providers and consulting organizations including Accenture, BT, Cognizant Technology Solutions, Deutsche Telekom, Fujitsu, HCL, HP Enterprise, IBM, Infosys, NTT, Optiv, SecureWorks, Tata Communications, Verizon and Wipro. The company is also a founding member of the Cloud Security Alliance (CSA).

10 For more information, please visit Qualys SupportQualys is committed to providing you with the most thorough support. Through online documentation, telephone help, and direct email support, Qualys ensures that your questions will be answered in the fastest time possible. We support you 7 days a week, 24 hours a day. Access support information at WelcomeAPI Conventions9 WelcomeThe Qualys API allows third parties to integrate their own applications with Qualys cloud security and compliance solutions using an extensible XML interface. APIs in this user Guide are supported using Qualys Cloud Platform (VM, PC).We recommend you join our Community and subscribe to our API Notifications RSS Feeds for announcements and discussions. API ConventionsQualys user AccountAuthentication with valid Qualys user account credentials is required for making Qualys API requests to the Qualys API servers.